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

vw_sql_pool_sensitivity_labels

Name	Datatype	Description
columnName	text	field from the properties object
column_name	text	field from the properties object
information_type	text	field from the properties object
information_type_id	text	field from the properties object
is_disabled	text	field from the properties object
label_id	text	field from the properties object
label_name	text	field from the properties object
managed_by	text	field from the properties object
rank	text	field from the properties object
resourceGroupName	text	field from the properties object
schemaName	text	field from the properties object
schema_name	text	field from the properties object
sensitivityLabelSource	text	field from the properties object
sqlPoolName	text	field from the properties object
subscriptionId	text	field from the properties object
tableName	text	field from the properties object
table_name	text	field from the properties object
workspaceName	text	field from the properties object

sql_pool_sensitivity_labels

Name	Datatype	Description
managedBy	string	managed by
properties	object	Properties of a sensitivity label.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	columnName, resourceGroupName, schemaName, sensitivityLabelSource, sqlPoolName, subscriptionId, tableName, workspaceName	Gets the sensitivity label of a given column
create_or_update	INSERT	columnName, resourceGroupName, schemaName, sensitivityLabelSource, sqlPoolName, subscriptionId, tableName, workspaceName	Creates or updates the sensitivity label of a given column in a Sql pool
delete	DELETE	columnName, resourceGroupName, schemaName, sensitivityLabelSource, sqlPoolName, subscriptionId, tableName, workspaceName	Deletes the sensitivity label of a given column in a Sql pool
update	UPDATE	resourceGroupName, sqlPoolName, subscriptionId, workspaceName	Update sensitivity labels of a given SQL Pool using an operations batch.
disable_recommendation	EXEC	columnName, resourceGroupName, schemaName, sensitivityLabelSource, sqlPoolName, subscriptionId, tableName, workspaceName	Disables sensitivity recommendations on a given column
enable_recommendation	EXEC	columnName, resourceGroupName, schemaName, sensitivityLabelSource, sqlPoolName, subscriptionId, tableName, workspaceName	Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)

SELECT examples

Gets the sensitivity label of a given column

vw_sql_pool_sensitivity_labels

SELECT
columnName,
column_name,
information_type,
information_type_id,
is_disabled,
label_id,
label_name,
managed_by,
rank,
resourceGroupName,
schemaName,
schema_name,
sensitivityLabelSource,
sqlPoolName,
subscriptionId,
tableName,
table_name,
workspaceName
FROM azure.synapse.vw_sql_pool_sensitivity_labels
WHERE columnName = '{{ columnName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND schemaName = '{{ schemaName }}'
AND sensitivityLabelSource = '{{ sensitivityLabelSource }}'
AND sqlPoolName = '{{ sqlPoolName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND tableName = '{{ tableName }}'
AND workspaceName = '{{ workspaceName }}';

sql_pool_sensitivity_labels

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

INSERT example

Use the following StackQL query and manifest file to create a new sql_pool_sensitivity_labels resource.

All Properties

/*+ create */
INSERT INTO azure.synapse.sql_pool_sensitivity_labels (
columnName,
resourceGroupName,
schemaName,
sensitivityLabelSource,
sqlPoolName,
subscriptionId,
tableName,
workspaceName,
properties
)
SELECT 
'{{ columnName }}',
'{{ resourceGroupName }}',
'{{ schemaName }}',
'{{ sensitivityLabelSource }}',
'{{ sqlPoolName }}',
'{{ subscriptionId }}',
'{{ tableName }}',
'{{ workspaceName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: schemaName
          value: string
        - name: tableName
          value: string
        - name: columnName
          value: string
        - name: labelName
          value: string
        - name: labelId
          value: string
        - name: informationType
          value: string
        - name: informationTypeId
          value: string
        - name: isDisabled
          value: boolean
        - name: rank
          value: string
    - name: managedBy
      value: string

UPDATE example

Updates a sql_pool_sensitivity_labels resource.

/*+ update */
UPDATE azure.synapse.sql_pool_sensitivity_labels
SET 
operations = '{{ operations }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND sqlPoolName = '{{ sqlPoolName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified sql_pool_sensitivity_labels resource.

/*+ delete */
DELETE FROM azure.synapse.sql_pool_sensitivity_labels
WHERE columnName = '{{ columnName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND schemaName = '{{ schemaName }}'
AND sensitivityLabelSource = '{{ sensitivityLabelSource }}'
AND sqlPoolName = '{{ sqlPoolName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND tableName = '{{ tableName }}'
AND workspaceName = '{{ workspaceName }}';