managed_database_vulnerability_assessment_scans

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

Overview

Name	managed_database_vulnerability_assessment_scans
Type	Resource
Id	azure.sql.managed_database_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.
endTime	string (date-time)	The scan end time (UTC).
errors	array	The scan errors.
numberOfFailedSecurityChecks	integer	The number of failed security checks.
scanId	string	The scan ID.
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)
storageContainerPath	string	The scan results storage container path.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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_database

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.
endTime	string (date-time)	The scan end time (UTC).
errors	array	The scan errors.
numberOfFailedSecurityChecks	integer	The number of failed security checks.
scanId	string	The scan ID.
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)
storageContainerPath	string	The scan results storage container path.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, managed_instance_name, database_name, vulnerability_assessment_name, scan_id, subscription_id		Gets a vulnerability assessment scan record of a database.
list_by_database	select	resource_group_name, managed_instance_name, database_name, vulnerability_assessment_name, subscription_id		Lists the vulnerability assessment scans of a database.
export	exec	resource_group_name, managed_instance_name, database_name, vulnerability_assessment_name, scan_id, subscription_id		Convert an existing scan result to a human readable format. If already exists nothing happens.
initiate_scan	exec	resource_group_name, managed_instance_name, database_name, vulnerability_assessment_name, scan_id, subscription_id		Executes a Vulnerability Assessment database scan.

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.
managed_instance_name	string	The name of the managed instance. 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.
subscription_id	string
vulnerability_assessment_name	string	The name of the vulnerability assessment. "default" Required.

SELECT examples

get

Gets a vulnerability assessment scan record of a database.

SELECT
id,
name,
endTime,
errors,
numberOfFailedSecurityChecks,
scanId,
startTime,
state,
storageContainerPath,
systemData,
triggerType,
type
FROM azure.sql.managed_database_vulnerability_assessment_scans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_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_database

Lists the vulnerability assessment scans of a database.

SELECT
id,
name,
endTime,
errors,
numberOfFailedSecurityChecks,
scanId,
startTime,
state,
storageContainerPath,
systemData,
triggerType,
type
FROM azure.sql.managed_database_vulnerability_assessment_scans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

export

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

EXEC azure.sql.managed_database_vulnerability_assessment_scans.export 
@resource_group_name='{{ resource_group_name }}' --required, 
@managed_instance_name='{{ managed_instance_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@vulnerability_assessment_name='{{ vulnerability_assessment_name }}' --required, 
@scan_id='{{ scan_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

initiate_scan

Executes a Vulnerability Assessment database scan.

EXEC azure.sql.managed_database_vulnerability_assessment_scans.initiate_scan 
@resource_group_name='{{ resource_group_name }}' --required, 
@managed_instance_name='{{ managed_instance_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@vulnerability_assessment_name='{{ vulnerability_assessment_name }}' --required, 
@scan_id='{{ scan_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;