database_vulnerability_assessment_scans

Creates, updates, deletes, gets or lists a database_vulnerability_assessment_scans resource.

Overview

Name	database_vulnerability_assessment_scans
Type	Resource
Id	azure.sql.database_vulnerability_assessment_scans

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the database vulnerability assessment scan record.

Name	Datatype	Description
properties	object	Resource properties.

list_by_database

Successfully retrieved the database vulnerability assessment scan records.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, databaseName, vulnerabilityAssessmentName, scanId, subscriptionId		Gets a vulnerability assessment scan record of a database.
list_by_database	select	resourceGroupName, serverName, databaseName, vulnerabilityAssessmentName, subscriptionId		Lists the vulnerability assessment scans of a database.
initiate_scan	exec	resourceGroupName, serverName, databaseName, vulnerabilityAssessmentName, scanId, subscriptionId		Executes a Vulnerability Assessment database scan.
export	exec	resourceGroupName, serverName, databaseName, vulnerabilityAssessmentName, scanId, subscriptionId		Convert an existing scan result to a human readable format. If already exists nothing happens

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
databaseName	string	The name of the scanned database.
resourceGroupName	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	string	The vulnerability assessment scan Id.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
vulnerabilityAssessmentName	string	The name of the vulnerability assessment.

SELECT examples

get

Gets a vulnerability assessment scan record of a database.

SELECT
properties
FROM azure.sql.database_vulnerability_assessment_scans
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND vulnerabilityAssessmentName = '{{ vulnerabilityAssessmentName }}' -- required
AND scanId = '{{ scanId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_database

Lists the vulnerability assessment scans of a database.

SELECT
properties
FROM azure.sql.database_vulnerability_assessment_scans
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND vulnerabilityAssessmentName = '{{ vulnerabilityAssessmentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

Lifecycle Methods

initiate_scan

Executes a Vulnerability Assessment database scan.

EXEC azure.sql.database_vulnerability_assessment_scans.initiate_scan 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@vulnerabilityAssessmentName='{{ vulnerabilityAssessmentName }}' --required, 
@scanId='{{ scanId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

export

Convert an existing scan result to a human readable format. If already exists nothing happens

EXEC azure.sql.database_vulnerability_assessment_scans.export 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@vulnerabilityAssessmentName='{{ vulnerabilityAssessmentName }}' --required, 
@scanId='{{ scanId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;