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

Successfully retrieved the Sql pool vulnerability assessment scan record.

Name	Datatype	Description
properties	object	Resource properties.

list

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	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, vulnerabilityAssessmentName, scanId		Gets a vulnerability assessment scan record of a Sql pool.
list	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, vulnerabilityAssessmentName		Lists the vulnerability assessment scans of a SQL pool.
initiate_scan	exec	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, vulnerabilityAssessmentName, scanId		Executes a Vulnerability Assessment database scan.
export	exec	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, vulnerabilityAssessmentName, scanId		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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
scanId	string	The vulnerability assessment scan Id of the scan to retrieve.
sqlPoolName	string	SQL pool name
subscriptionId	string	The ID of the target subscription.
vulnerabilityAssessmentName	string	The name of the vulnerability assessment.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets a vulnerability assessment scan record of a Sql pool.

SELECT
properties
FROM azure.synapse.sql_pool_vulnerability_assessment_scans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND vulnerabilityAssessmentName = '{{ vulnerabilityAssessmentName }}' -- required
AND scanId = '{{ scanId }}' -- required
;

list

Lists the vulnerability assessment scans of a SQL pool.

SELECT
properties
FROM azure.synapse.sql_pool_vulnerability_assessment_scans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND vulnerabilityAssessmentName = '{{ vulnerabilityAssessmentName }}' -- required
;

Lifecycle Methods

initiate_scan

Executes a Vulnerability Assessment database scan.

EXEC azure.synapse.sql_pool_vulnerability_assessment_scans.initiate_scan 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@sqlPoolName='{{ sqlPoolName }}' --required, 
@vulnerabilityAssessmentName='{{ vulnerabilityAssessmentName }}' --required, 
@scanId='{{ scanId }}' --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 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@sqlPoolName='{{ sqlPoolName }}' --required, 
@vulnerabilityAssessmentName='{{ vulnerabilityAssessmentName }}' --required, 
@scanId='{{ scanId }}' --required
;