Sql Pool Vulnerability Assessments - List
Lists the vulnerability assessment policies associated with a SQL pool.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/vulnerabilityAssessments?api-version=2021-06-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
sql
|
path | True |
string |
SQL pool name |
subscription
|
path | True |
string |
The ID of the target subscription. |
workspace
|
path | True |
string |
The name of the workspace. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
*** Error Responses: ***
|
Examples
Get a vulnerability assessment of a SQL Analytics pool
Sample Request
GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments?api-version=2021-06-01
Sample Response
{
"value": [
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default",
"name": "default",
"type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments",
"properties": {
"recurringScans": {
"isEnabled": true,
"emailSubscriptionAdmins": true,
"emails": [
"email1@mail.com",
"email2@mail.com"
]
}
}
}
]
}
Definitions
Name | Description |
---|---|
Sql |
A Sql pool vulnerability assessment. |
Sql |
A list of the Sql pool's vulnerability assessments. |
Vulnerability |
Properties of a Vulnerability Assessment recurring scans. |
SqlPoolVulnerabilityAssessment
A Sql pool vulnerability assessment.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties.recurringScans |
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. |
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. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
SqlPoolVulnerabilityAssessmentListResult
A list of the Sql pool's vulnerability assessments.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link to retrieve next page of results. |
value |
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. |