Sql Pool Vulnerability Assessment Scans - Get
Gets a vulnerability assessment scan record of a Sql pool.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/vulnerabilityAssessments/default/scans/{scanId}?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. |
scan
|
path | True |
string |
The vulnerability assessment scan Id of the scan to retrieve. |
sql
|
path | True |
string |
SQL pool name |
subscription
|
path | True |
string |
The ID of the target subscription. |
vulnerability
|
path | True |
The name of the vulnerability assessment. |
|
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 |
Successfully retrieved the Sql pool vulnerability assessment scan record. |
|
Other Status Codes |
*** Error Responses: ***
|
Examples
Gets a database vulnerability assessment scan record by scan ID
Sample request
GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4711/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6411/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan001?api-version=2021-06-01
Sample response
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan001",
"name": "scan001",
"type": "Microsoft.Synapse/workspaces/sqlPools/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 |
---|---|
Vulnerability |
The name of the vulnerability assessment. |
Vulnerability |
Properties of a vulnerability assessment scan error. |
Vulnerability |
A vulnerability assessment scan record. |
Vulnerability |
The scan status. |
Vulnerability |
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 |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties.endTime |
string |
The scan end time (UTC). |
properties.errors |
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 |
The scan status. |
|
properties.storageContainerPath |
string |
The scan results storage container path. |
properties.triggerType |
The scan trigger type. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
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 |