sql_pool_vulnerability_assessment_scans

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

Overview

Name	sql_pool_vulnerability_assessment_scans
Type	Resource
Id	azure.synapse.sql_pool_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".
storageContainerPath	string	The scan results storage container path.
triggerType	string	The scan trigger type. Known values are: "OnDemand" and "Recurring".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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".
storageContainerPath	string	The scan results storage container path.
triggerType	string	The scan trigger type. Known values are: "OnDemand" and "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, workspace_name, sql_pool_name, vulnerability_assessment_name, scan_id, subscription_id		Gets a vulnerability assessment scan record of a Sql pool.
list	select	resource_group_name, workspace_name, sql_pool_name, vulnerability_assessment_name, subscription_id		Lists the vulnerability assessment scans of a SQL pool. Lists the vulnerability assessment scans of a SQL pool.
initiate_scan	exec	resource_group_name, workspace_name, sql_pool_name, vulnerability_assessment_name, scan_id, subscription_id		Executes a Vulnerability Assessment database scan.
export	exec	resource_group_name, workspace_name, sql_pool_name, vulnerability_assessment_name, scan_id, subscription_id		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
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.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
vulnerability_assessment_name	string	The name of the vulnerability assessment. "default" Required.
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Gets a vulnerability assessment scan record of a Sql pool.

SELECT
id,
name,
endTime,
errors,
numberOfFailedSecurityChecks,
scanId,
startTime,
state,
storageContainerPath,
triggerType,
type
FROM azure.synapse.sql_pool_vulnerability_assessment_scans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' -- required
AND scan_id = '{{ scan_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the vulnerability assessment scans of a SQL pool. Lists the vulnerability assessment scans of a SQL pool.

SELECT
id,
name,
endTime,
errors,
numberOfFailedSecurityChecks,
scanId,
startTime,
state,
storageContainerPath,
triggerType,
type
FROM azure.synapse.sql_pool_vulnerability_assessment_scans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

initiate_scan

Executes a Vulnerability Assessment database scan.

EXEC azure.synapse.sql_pool_vulnerability_assessment_scans.initiate_scan 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@sql_pool_name='{{ sql_pool_name }}' --required, 
@vulnerability_assessment_name='{{ vulnerability_assessment_name }}' --required, 
@scan_id='{{ scan_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

export

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

EXEC azure.synapse.sql_pool_vulnerability_assessment_scans.export 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@sql_pool_name='{{ sql_pool_name }}' --required, 
@vulnerability_assessment_name='{{ vulnerability_assessment_name }}' --required, 
@scan_id='{{ scan_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;