database_sql_vulnerability_assessment_scans

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

Overview

Name	database_sql_vulnerability_assessment_scans
Type	Resource
Id	azure.sql.database_sql_vulnerability_assessment_scans

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	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.
database	string	The database name.
endTime	string (date-time)	The scan end time (UTC).
errors	array	The scan errors.
highSeverityFailedRulesCount	integer	The number of failed rules with high severity.
isBaselineApplied	boolean	Baseline created for this database, and has one or more rules.
lastScanTime	string (date-time)	The last scan time.
lowSeverityFailedRulesCount	integer	The number of failed rules with low severity.
mediumSeverityFailedRulesCount	integer	The number of failed rules with medium severity.
scanId	string	The scan ID.
server	string	The server name.
sqlVersion	string	The SQL version.
startTime	string (date-time)	The scan start time (UTC).
state	string	The scan status. Known values are: "Passed", "Failed", "FailedToRun", and "InProgress". (Passed, Failed, FailedToRun, InProgress)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalFailedRulesCount	integer	The number of total failed rules.
totalPassedRulesCount	integer	The number of total passed rules.
totalRulesCount	integer	The number of total rules assessed.
triggerType	string	The scan trigger type. Known values are: "OnDemand" and "Recurring". (OnDemand, Recurring)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_sql_vulnerability_assessments

Name	Datatype	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.
database	string	The database name.
endTime	string (date-time)	The scan end time (UTC).
errors	array	The scan errors.
highSeverityFailedRulesCount	integer	The number of failed rules with high severity.
isBaselineApplied	boolean	Baseline created for this database, and has one or more rules.
lastScanTime	string (date-time)	The last scan time.
lowSeverityFailedRulesCount	integer	The number of failed rules with low severity.
mediumSeverityFailedRulesCount	integer	The number of failed rules with medium severity.
scanId	string	The scan ID.
server	string	The server name.
sqlVersion	string	The SQL version.
startTime	string (date-time)	The scan start time (UTC).
state	string	The scan status. Known values are: "Passed", "Failed", "FailedToRun", and "InProgress". (Passed, Failed, FailedToRun, InProgress)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalFailedRulesCount	integer	The number of total failed rules.
totalPassedRulesCount	integer	The number of total passed rules.
totalRulesCount	integer	The number of total rules assessed.
triggerType	string	The scan trigger type. Known values are: "OnDemand" and "Recurring". (OnDemand, Recurring)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, database_name, vulnerability_assessment_name, scan_id, subscription_id		Get a database vulnerability assessment scan result.
list_by_sql_vulnerability_assessments	select	resource_group_name, server_name, database_name, vulnerability_assessment_name, subscription_id		Lists the vulnerability assessment scans of a database.

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
database_name	string	The name of the database. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
scan_id	string	The vulnerability assessment scan Id of the scan to retrieve. Required.
server_name	string	The name of the server. Required.
subscription_id	string
vulnerability_assessment_name	string	The name of the vulnerability assessment. "default" Required.

SELECT examples

get

Get a database vulnerability assessment scan result.

SELECT
id,
name,
database,
endTime,
errors,
highSeverityFailedRulesCount,
isBaselineApplied,
lastScanTime,
lowSeverityFailedRulesCount,
mediumSeverityFailedRulesCount,
scanId,
server,
sqlVersion,
startTime,
state,
systemData,
totalFailedRulesCount,
totalPassedRulesCount,
totalRulesCount,
triggerType,
type
FROM azure.sql.database_sql_vulnerability_assessment_scans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' -- required
AND scan_id = '{{ scan_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_sql_vulnerability_assessments

Lists the vulnerability assessment scans of a database.

SELECT
id,
name,
database,
endTime,
errors,
highSeverityFailedRulesCount,
isBaselineApplied,
lastScanTime,
lowSeverityFailedRulesCount,
mediumSeverityFailedRulesCount,
scanId,
server,
sqlVersion,
startTime,
state,
systemData,
totalFailedRulesCount,
totalPassedRulesCount,
totalRulesCount,
triggerType,
type
FROM azure.sql.database_sql_vulnerability_assessment_scans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;