sql_pool_sensitivity_labels

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

Overview

Name	sql_pool_sensitivity_labels
Type	Resource
Id	azure.synapse.sql_pool_sensitivity_labels

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the sensitivity label.

Name	Datatype	Description
managedBy	string	managed by
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, schemaName, tableName, columnName, sensitivityLabelSource		Gets the sensitivity label of a given column
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, schemaName, tableName, columnName, sensitivityLabelSource		Creates or updates the sensitivity label of a given column in a Sql pool
update	update	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Update sensitivity labels of a given SQL Pool using an operations batch.
delete	delete	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, schemaName, tableName, columnName, sensitivityLabelSource		Deletes the sensitivity label of a given column in a Sql pool
enable_recommendation	exec	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, schemaName, tableName, columnName, sensitivityLabelSource		Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)
disable_recommendation	exec	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, schemaName, tableName, columnName, sensitivityLabelSource		Disables sensitivity recommendations on a given column

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
columnName	string	The name of the column.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
schemaName	string	The name of the schema.
sensitivityLabelSource	string	The source of the sensitivity label.
sqlPoolName	string	SQL pool name
subscriptionId	string	The ID of the target subscription.
tableName	string	The name of the table.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets the sensitivity label of a given column

SELECT
managedBy,
properties
FROM azure.synapse.sql_pool_sensitivity_labels
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND schemaName = '{{ schemaName }}' -- required
AND tableName = '{{ tableName }}' -- required
AND columnName = '{{ columnName }}' -- required
AND sensitivityLabelSource = '{{ sensitivityLabelSource }}' -- required
;

INSERT examples

create_or_update

Creates or updates the sensitivity label of a given column in a Sql pool

INSERT INTO azure.synapse.sql_pool_sensitivity_labels (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sqlPoolName,
schemaName,
tableName,
columnName,
sensitivityLabelSource
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sqlPoolName }}',
'{{ schemaName }}',
'{{ tableName }}',
'{{ columnName }}',
'{{ sensitivityLabelSource }}'
RETURNING
managedBy,
properties
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_sensitivity_labels
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_pool_sensitivity_labels resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_pool_sensitivity_labels resource.
    - name: workspaceName
      value: string
      description: Required parameter for the sql_pool_sensitivity_labels resource.
    - name: sqlPoolName
      value: string
      description: Required parameter for the sql_pool_sensitivity_labels resource.
    - name: schemaName
      value: string
      description: Required parameter for the sql_pool_sensitivity_labels resource.
    - name: tableName
      value: string
      description: Required parameter for the sql_pool_sensitivity_labels resource.
    - name: columnName
      value: string
      description: Required parameter for the sql_pool_sensitivity_labels resource.
    - name: sensitivityLabelSource
      value: string
      description: Required parameter for the sql_pool_sensitivity_labels resource.
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Update sensitivity labels of a given SQL Pool using an operations batch.

UPDATE azure.synapse.sql_pool_sensitivity_labels
SET 
data__operations = '{{ operations }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND sqlPoolName = '{{ sqlPoolName }}' --required;

DELETE examples

delete

Deletes the sensitivity label of a given column in a Sql pool

DELETE FROM azure.synapse.sql_pool_sensitivity_labels
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND sqlPoolName = '{{ sqlPoolName }}' --required
AND schemaName = '{{ schemaName }}' --required
AND tableName = '{{ tableName }}' --required
AND columnName = '{{ columnName }}' --required
AND sensitivityLabelSource = '{{ sensitivityLabelSource }}' --required
;

Lifecycle Methods

enable_recommendation

Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)

EXEC azure.synapse.sql_pool_sensitivity_labels.enable_recommendation 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@sqlPoolName='{{ sqlPoolName }}' --required, 
@schemaName='{{ schemaName }}' --required, 
@tableName='{{ tableName }}' --required, 
@columnName='{{ columnName }}' --required, 
@sensitivityLabelSource='{{ sensitivityLabelSource }}' --required
;

disable_recommendation

Disables sensitivity recommendations on a given column

EXEC azure.synapse.sql_pool_sensitivity_labels.disable_recommendation 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@sqlPoolName='{{ sqlPoolName }}' --required, 
@schemaName='{{ schemaName }}' --required, 
@tableName='{{ tableName }}' --required, 
@columnName='{{ columnName }}' --required, 
@sensitivityLabelSource='{{ sensitivityLabelSource }}' --required
;