Database Vulnerability Assessment Scans - Get

Service:

SQL Database

API Version:

2021-11-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=2021-11-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		*** Error Responses: *** 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. 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. 400 VulnerabilityAssessmentADSIsDisabled - Advanced Data Security should be enabled in order to use Vulnerability Assessment. 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 VulnerabilityAssessmentStorageOutboundFirewallNotAllowed - The storage account is not in the list of Outbound Firewall Rules. 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. 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

Sample Request

HTTP

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=2021-11-01

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.VulnerabilityAssessmentName;

/** Samples for DatabaseVulnerabilityAssessmentScans Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * DatabaseVulnerabilityAssessmentScanRecordsGet.json
     */
    /**
     * Sample code: Gets a database vulnerability assessment scan record by scan ID.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getsADatabaseVulnerabilityAssessmentScanRecordByScanID(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseVulnerabilityAssessmentScans().getWithResponse(
            "vulnerabilityassessmenttest-4711", "vulnerabilityassessmenttest-6411", "testdb",
            VulnerabilityAssessmentName.DEFAULT, "scan001", Context.NONE);
    }
}

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
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.

VulnerabilityAssessmentName

The name of the vulnerability assessment.

Name	Type	Description
default	string

VulnerabilityAssessmentScanError

Properties of a vulnerability assessment scan error.

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

VulnerabilityAssessmentScanRecord

A vulnerability assessment scan record.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.endTime	string	The scan end time (UTC).
properties.errors	VulnerabilityAssessmentScanError[]	The scan errors.
properties.numberOfFailedSecurityChecks	integer	The number of failed security checks.
properties.scanId	string	The scan ID.
properties.startTime	string	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

The scan status.

Name	Type	Description
Failed	string
FailedToRun	string
InProgress	string
Passed	string

VulnerabilityAssessmentScanTriggerType

The scan trigger type.

Name	Type	Description
OnDemand	string
Recurring	string