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

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.
columnName	string	The column name.
informationType	string	The information type.
informationTypeId	string	The information type ID.
isDisabled	boolean	Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.
labelId	string	The label ID.
labelName	string	The label name.
managedBy	string	managed by.
rank	string	Known values are: "None", "Low", "Medium", "High", and "Critical".
schemaName	string	The schema name.
tableName	string	The table name.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_recommended

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.
columnName	string	The column name.
informationType	string	The information type.
informationTypeId	string	The information type ID.
isDisabled	boolean	Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.
labelId	string	The label ID.
labelName	string	The label name.
managedBy	string	managed by.
rank	string	Known values are: "None", "Low", "Medium", "High", and "Critical".
schemaName	string	The schema name.
tableName	string	The table name.
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, schema_name, table_name, column_name, sensitivity_label_source, subscription_id		Gets the sensitivity label of a given column.
list_recommended	select	resource_group_name, workspace_name, sql_pool_name, subscription_id	includeDisabledRecommendations, $skipToken, $filter	Gets sensitivity labels of a given SQL pool. Gets sensitivity labels of a given SQL pool.
create_or_update	insert	resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, column_name, subscription_id		Creates or updates the sensitivity label of a given column in a Sql pool.
update	update	resource_group_name, workspace_name, sql_pool_name, subscription_id		Update sensitivity labels of a given SQL Pool using an operations batch.
create_or_update	replace	resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, column_name, subscription_id		Creates or updates the sensitivity label of a given column in a Sql pool.
delete	delete	resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, column_name, subscription_id		Deletes the sensitivity label of a given column in a Sql pool.
list_current	exec	resource_group_name, workspace_name, sql_pool_name, subscription_id	$filter	Gets SQL pool sensitivity labels. Gets SQL pool sensitivity labels.
enable_recommendation	exec	resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, column_name, subscription_id		Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns).
disable_recommendation	exec	resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, column_name, subscription_id		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
column_name	string	The name of the column. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
schema_name	string	The name of the schema. Required.
sensitivity_label_source	string	The source of the sensitivity label. Known values are: "current" and "recommended". Required.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
table_name	string	The name of the table. Required.
workspace_name	string	The name of the workspace. Required.
$filter	string	An OData filter expression that filters elements in the collection. Default value is None.
$skipToken	string	An OData query option to indicate how many elements to skip in the collection. Default value is None.
includeDisabledRecommendations	boolean	Specifies whether to include disabled recommendations or not. Default value is None.

SELECT examples

get

Gets the sensitivity label of a given column.

SELECT
id,
name,
columnName,
informationType,
informationTypeId,
isDisabled,
labelId,
labelName,
managedBy,
rank,
schemaName,
tableName,
type
FROM azure.synapse.sql_pool_sensitivity_labels
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND table_name = '{{ table_name }}' -- required
AND column_name = '{{ column_name }}' -- required
AND sensitivity_label_source = '{{ sensitivity_label_source }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_recommended

Gets sensitivity labels of a given SQL pool. Gets sensitivity labels of a given SQL pool.

SELECT
id,
name,
columnName,
informationType,
informationTypeId,
isDisabled,
labelId,
labelName,
managedBy,
rank,
schemaName,
tableName,
type
FROM azure.synapse.sql_pool_sensitivity_labels
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND includeDisabledRecommendations = '{{ includeDisabledRecommendations }}'
AND $skipToken = '{{ $skipToken }}'
AND $filter = '{{ $filter }}'
;

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 (
properties,
resource_group_name,
workspace_name,
sql_pool_name,
schema_name,
table_name,
column_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ sql_pool_name }}',
'{{ schema_name }}',
'{{ table_name }}',
'{{ column_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
managedBy,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_sensitivity_labels
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_pool_sensitivity_labels resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the sql_pool_sensitivity_labels resource.
  - name: sql_pool_name
    value: "{{ sql_pool_name }}"
    description: Required parameter for the sql_pool_sensitivity_labels resource.
  - name: schema_name
    value: "{{ schema_name }}"
    description: Required parameter for the sql_pool_sensitivity_labels resource.
  - name: table_name
    value: "{{ table_name }}"
    description: Required parameter for the sql_pool_sensitivity_labels resource.
  - name: column_name
    value: "{{ column_name }}"
    description: Required parameter for the sql_pool_sensitivity_labels resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_pool_sensitivity_labels resource.
  - name: properties
    value:
      labelName: "{{ labelName }}"
      labelId: "{{ labelId }}"
      informationType: "{{ informationType }}"
      informationTypeId: "{{ informationTypeId }}"
      rank: "{{ rank }}"

UPDATE examples

update

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

UPDATE azure.synapse.sql_pool_sensitivity_labels
SET 
operations = '{{ operations }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required;

REPLACE examples

create_or_update

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

REPLACE azure.synapse.sql_pool_sensitivity_labels
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND schema_name = '{{ schema_name }}' --required
AND table_name = '{{ table_name }}' --required
AND column_name = '{{ column_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
managedBy,
properties,
type;

DELETE examples

delete

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

DELETE FROM azure.synapse.sql_pool_sensitivity_labels
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND schema_name = '{{ schema_name }}' --required
AND table_name = '{{ table_name }}' --required
AND column_name = '{{ column_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_current

Gets SQL pool sensitivity labels. Gets SQL pool sensitivity labels.

EXEC azure.synapse.sql_pool_sensitivity_labels.list_current 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@sql_pool_name='{{ sql_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$filter='{{ $filter }}'
;

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 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@sql_pool_name='{{ sql_pool_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@column_name='{{ column_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

disable_recommendation

Disables sensitivity recommendations on a given column.

EXEC azure.synapse.sql_pool_sensitivity_labels.disable_recommendation 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@sql_pool_name='{{ sql_pool_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@column_name='{{ column_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;