sql_pool_vulnerability_assessments

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

Overview

Name	sql_pool_vulnerability_assessments
Type	Resource
Id	azure.synapse.sql_pool_vulnerability_assessments

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the Sql pool vulnerability assessment.

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		Gets the Sql pool's vulnerability assessment.
list	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Lists the vulnerability assessment policies associated with a SQL pool.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, vulnerabilityAssessmentName		Creates or updates the Sql pool vulnerability assessment.
delete	delete	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, vulnerabilityAssessmentName		Removes the database's vulnerability assessment.

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.
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 the Sql pool's vulnerability assessment.

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

list

Lists the vulnerability assessment policies associated with a SQL pool.

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

INSERT examples

create_or_update

Creates or updates the Sql pool vulnerability assessment.

INSERT INTO azure.synapse.sql_pool_vulnerability_assessments (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sqlPoolName,
vulnerabilityAssessmentName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sqlPoolName }}',
'{{ vulnerabilityAssessmentName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_vulnerability_assessments
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_pool_vulnerability_assessments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_pool_vulnerability_assessments resource.
    - name: workspaceName
      value: string
      description: Required parameter for the sql_pool_vulnerability_assessments resource.
    - name: sqlPoolName
      value: string
      description: Required parameter for the sql_pool_vulnerability_assessments resource.
    - name: vulnerabilityAssessmentName
      value: string
      description: Required parameter for the sql_pool_vulnerability_assessments resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Removes the database's vulnerability assessment.

DELETE FROM azure.synapse.sql_pool_vulnerability_assessments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND sqlPoolName = '{{ sqlPoolName }}' --required
AND vulnerabilityAssessmentName = '{{ vulnerabilityAssessmentName }}' --required
;