Sql Vulnerability Assessment Execute Scan - Execute

Service:

SQL Database

API Version:

2024-05-01-preview

Executes a Vulnerability Assessment database scan.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/default/initiateScan?systemDatabaseName=master&api-version=2024-05-01-preview

URI Parameters

Name	In	Required	Type	Description
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.
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.
systemDatabaseName	query	True	VulnerabilityAssessmentSystemDatabaseName	The vulnerability assessment system database name.

Responses

Name	Type	Description
200 OK		Successfully executed a Vulnerability Assessment database scan.
202 Accepted		Successfully started a Vulnerability Assessment database scan.
Other Status Codes	ErrorResponse	*** Error Responses: *** 400 SqlVulnerabilityAssessmentIsDisabled - SQL vulnerability assessment feature is disabled. please enable the feature before executing other SQL vulnerability assessment operations. 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object. 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 SourceDatabaseNotFound - The source database does not exist. 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance. 404 OperationIdNotFound - The operation with Id does not exist. 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - SQL Vulnerability Assessment scan is already in progress 409 VulnerabilityAssessmentStoragelessIsEnabled - Vulnerability Assessment is enabled on this server or one of its underlying databases with an incompatible version. Additional troubleshooting information can be found https://aka.ms/SQLVAStoragelessDocumentation. 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled. 409 OperationCancelled - The operation has been cancelled by user. 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 500 DatabaseIsUnavailable - Loading failed. Please try again later. 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Executes a database's vulnerability assessment scan.

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4711/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6411/sqlVulnerabilityAssessments/default/initiateScan?systemDatabaseName=master&api-version=2024-05-01-preview

Sample response

Status code:

200

Status code:

202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/westus/SqlVulnerabilityAssessmentScansExecute/00000000-1111-2222-3333-444444444444?api-version=2022-02-01-preview

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
VulnerabilityAssessmentName	The name of the vulnerability assessment.
VulnerabilityAssessmentSystemDatabaseName	The vulnerability assessment system database name.

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.

VulnerabilityAssessmentName

The name of the vulnerability assessment.

Name	Type	Description
default	string

VulnerabilityAssessmentSystemDatabaseName

The vulnerability assessment system database name.

Name	Type	Description
master	string