Database Vulnerability Assessment Scans - Get

Service:: SQL Database

API Version:: 2023-08-01

Gets a vulnerability assessment scan record of a database.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/default/scans/{scanId}?api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
scanId	path	True	string	The vulnerability assessment scan Id of the scan to retrieve.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
vulnerabilityAssessmentName	path	True	VulnerabilityAssessmentName	The name of the vulnerability assessment.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	VulnerabilityAssessmentScanRecord	Successfully retrieved the database vulnerability assessment scan record.
Other Status Codes	ErrorResponse	* Error Responses: * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it. 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. 400 VulnerabilityAssessmentStorageOutboundFirewallNotAllowed - The storage account is not in the list of Outbound Firewall Rules. 400 VulnerabilityAssessmentADSIsDisabled - Advanced Data Security should be enabled in order to use Vulnerability Assessment. 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist. 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid. 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 SourceDatabaseNotFound - The source database does not exist. 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress. 500 DatabaseIsUnavailable - Loading failed. Please try again later.

Name

Type

Description

200 OK

VulnerabilityAssessmentScanRecord

Successfully retrieved the database vulnerability assessment scan record.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy
400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.
400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings.
400 VulnerabilityAssessmentStorageOutboundFirewallNotAllowed - The storage account is not in the list of Outbound Firewall Rules.
400 VulnerabilityAssessmentADSIsDisabled - Advanced Data Security should be enabled in order to use Vulnerability Assessment.
400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.
400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.
404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.
404 SubscriptionDoesNotHaveServer - The requested server was not found
404 SourceDatabaseNotFound - The source database does not exist.
409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.
500 DatabaseIsUnavailable - Loading failed. Please try again later.

Examples

Gets a database vulnerability assessment scan record by scan ID

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4711/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6411/databases/testdb/vulnerabilityAssessments/default/scans/scan001?api-version=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DatabaseVulnerabilityAssessmentScanRecordsGet.json
// this example is just showing the usage of "DatabaseVulnerabilityAssessmentScans_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseVulnerabilityAssessmentScanResource created on azure
// for more information of creating SqlDatabaseVulnerabilityAssessmentScanResource, please refer to the document of SqlDatabaseVulnerabilityAssessmentScanResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "vulnerabilityassessmenttest-4711";
string serverName = "vulnerabilityassessmenttest-6411";
string databaseName = "testdb";
VulnerabilityAssessmentName vulnerabilityAssessmentName = VulnerabilityAssessmentName.Default;
string scanId = "scan001";
ResourceIdentifier sqlDatabaseVulnerabilityAssessmentScanResourceId = SqlDatabaseVulnerabilityAssessmentScanResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, vulnerabilityAssessmentName, scanId);
SqlDatabaseVulnerabilityAssessmentScanResource sqlDatabaseVulnerabilityAssessmentScan = client.GetSqlDatabaseVulnerabilityAssessmentScanResource(sqlDatabaseVulnerabilityAssessmentScanResourceId);

// invoke the operation
SqlDatabaseVulnerabilityAssessmentScanResource result = await sqlDatabaseVulnerabilityAssessmentScan.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VulnerabilityAssessmentScanRecordData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6440/databases/testdb/vulnerabilityAssessments/default/scans/scan001",
  "name": "scan001",
  "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments/scans",
  "properties": {
    "scanId": "scan001",
    "triggerType": "OnDemand",
    "state": "Passed",
    "startTime": "2017-12-12T17:45:06Z",
    "endTime": "2017-12-12T17:47:06Z",
    "errors": [],
    "storageContainerPath": "https://myaccount.blob.core.windows.net/vulnerability-assessment",
    "numberOfFailedSecurityChecks": 9
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
VulnerabilityAssessmentName	The name of the vulnerability assessment.
VulnerabilityAssessmentScanError	Properties of a vulnerability assessment scan error.
VulnerabilityAssessmentScanRecord	A vulnerability assessment scan record.
VulnerabilityAssessmentScanState	The scan status.
VulnerabilityAssessmentScanTriggerType	The scan trigger type.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

VulnerabilityAssessmentName

Enumeration

The name of the vulnerability assessment.

Value	Description
default

VulnerabilityAssessmentScanError

Object

Properties of a vulnerability assessment scan error.

Name	Type	Description
code	string	The error code.
message	string	The error message.

VulnerabilityAssessmentScanRecord

Object

A vulnerability assessment scan record.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.endTime	string (date-time)	The scan end time (UTC).
properties.errors	VulnerabilityAssessmentScanError[]	The scan errors.
properties.numberOfFailedSecurityChecks	integer (int32)	The number of failed security checks.
properties.scanId	string	The scan ID.
properties.startTime	string (date-time)	The scan start time (UTC).
properties.state	VulnerabilityAssessmentScanState	The scan status.
properties.storageContainerPath	string	The scan results storage container path.
properties.triggerType	VulnerabilityAssessmentScanTriggerType	The scan trigger type.
type	string	Resource type.

VulnerabilityAssessmentScanState

Enumeration

The scan status.

Value	Description
Passed
Failed
FailedToRun
InProgress

VulnerabilityAssessmentScanTriggerType

Enumeration

The scan trigger type.

Value	Description
OnDemand
Recurring

Share via

Database Vulnerability Assessment Scans - Get

URI Parameters

Responses

Examples

Gets a database vulnerability assessment scan record by scan ID

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

VulnerabilityAssessmentName

VulnerabilityAssessmentScanError

VulnerabilityAssessmentScanRecord

VulnerabilityAssessmentScanState

VulnerabilityAssessmentScanTriggerType