Database Vulnerability Assessments - List By Database

Service:

SQL Database

API Version:

2021-11-01

Lists the vulnerability assessment policies associated with a database.

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

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database for which the vulnerability assessment policies are defined.
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.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	DatabaseVulnerabilityAssessmentListResult	Successfully retrieved the database vulnerability assessment policies.
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

Get the database's vulnerability assessment policies

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments?api-version=2021-11-01

Java

/**
 * Samples for DatabaseVulnerabilityAssessments ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * DatabaseVulnerabilityAssessmentListByDatabase.json
     */
    /**
     * Sample code: Get the database's vulnerability assessment policies.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getTheDatabaseSVulnerabilityAssessmentPolicies(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseVulnerabilityAssessments().listByDatabase(
            "vulnerabilityaseessmenttest-4799", "vulnerabilityaseessmenttest-6440", "testdb",
            com.azure.core.util.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

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default",
      "name": "default",
      "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments",
      "properties": {
        "recurringScans": {
          "isEnabled": true,
          "emailSubscriptionAdmins": true,
          "emails": [
            "email1@mail.com",
            "email2@mail.com"
          ]
        }
      }
    }
  ]
}

Definitions

Name	Description
DatabaseVulnerabilityAssessment	A database vulnerability assessment.
DatabaseVulnerabilityAssessmentListResult	A list of the database's vulnerability assessments.
VulnerabilityAssessmentRecurringScansProperties	Properties of a Vulnerability Assessment recurring scans.

DatabaseVulnerabilityAssessment

A database vulnerability assessment.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.recurringScans	VulnerabilityAssessmentRecurringScansProperties	The recurring scans settings
properties.storageAccountAccessKey	string	Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall
properties.storageContainerPath	string	A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set
properties.storageContainerSasKey	string	A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall
type	string	Resource type.

DatabaseVulnerabilityAssessmentListResult

A list of the database's vulnerability assessments.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	DatabaseVulnerabilityAssessment[]	Array of results.

VulnerabilityAssessmentRecurringScansProperties

Properties of a Vulnerability Assessment recurring scans.

Name	Type	Default value	Description
emailSubscriptionAdmins	boolean	True	Specifies that the schedule scan notification will be is sent to the subscription administrators.
emails	string[]		Specifies an array of e-mail addresses to which the scan notification is sent.
isEnabled	boolean		Recurring scans state.