Share via

Database Vulnerability Assessments - List By Database

Service:
SQL Database
API Version:
2025-01-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=2025-01-01

URI Parameters

Name In Required Type Description
databaseName
 path True

string

The name of the database for which the vulnerability assessment is defined.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
serverName
 path True

string

The name of the server.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

DatabaseVulnerabilityAssessmentListResult

Azure operation completed successfully.
Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get the database's vulnerability assessment policies

Sample request

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=2025-01-01

Sample response

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

Definitions

Name Description
createdByType

The type of identity that created the resource.
DatabaseVulnerabilityAssessment

A database vulnerability assessment.
DatabaseVulnerabilityAssessmentListResult

The response of a DatabaseVulnerabilityAssessment list operation.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
systemData

Metadata pertaining to creation and last modification of the resource.
VulnerabilityAssessmentRecurringScansProperties

Properties of a Vulnerability Assessment recurring scans.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

DatabaseVulnerabilityAssessment

Object

A database vulnerability assessment.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

The name of the resource
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
systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DatabaseVulnerabilityAssessmentListResult

Object

The response of a DatabaseVulnerabilityAssessment list operation.

Name Type Description
nextLink

string (uri)

The link to the next page of items
value

DatabaseVulnerabilityAssessment[]

The DatabaseVulnerabilityAssessment items on this page

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.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.

VulnerabilityAssessmentRecurringScansProperties

Object

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.