sensitivity_labels

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

Overview

Name	sensitivity_labels
Type	Resource
Id	azure.sql.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.
clientClassificationSource	string	Known values are: "None", "Native", "Recommended", and "MIP". (None, Native, Recommended, MIP)
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	Resource that manages the sensitivity label.
rank	string	Known values are: "None", "Low", "Medium", "High", and "Critical". (None, Low, Medium, High, Critical)
schemaName	string	The schema name.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tableName	string	The table name.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_database

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.
clientClassificationSource	string	Known values are: "None", "Native", "Recommended", and "MIP". (None, Native, Recommended, MIP)
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	Resource that manages the sensitivity label.
rank	string	Known values are: "None", "Low", "Medium", "High", and "Critical". (None, Low, Medium, High, Critical)
schemaName	string	The schema name.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, server_name, database_name, schema_name, table_name, column_name, sensitivity_label_source, subscription_id		Gets the sensitivity label of a given column.
list_by_database	select	resource_group_name, server_name, database_name, subscription_id	$filter	Gets the sensitivity labels of a given database.
create_or_update	insert	resource_group_name, server_name, database_name, schema_name, table_name, column_name, subscription_id		Creates or updates the sensitivity label of a given column.
update	update	resource_group_name, server_name, database_name, subscription_id		Update sensitivity labels of a given database using an operations batch.
create_or_update	replace	resource_group_name, server_name, database_name, schema_name, table_name, column_name, subscription_id		Creates or updates the sensitivity label of a given column.
delete	delete	resource_group_name, server_name, database_name, schema_name, table_name, column_name, subscription_id		Deletes the sensitivity label of a given column.
list_recommended_by_database	exec	resource_group_name, server_name, database_name, subscription_id	$skipToken, includeDisabledRecommendations, $filter	Gets the sensitivity labels of a given database.
list_current_by_database	exec	resource_group_name, server_name, database_name, subscription_id	$skipToken, $count, $filter	Gets the sensitivity labels of a given database.
disable_recommendation	exec	resource_group_name, server_name, database_name, schema_name, table_name, column_name, subscription_id		Disables sensitivity recommendations on a given column.
enable_recommendation	exec	resource_group_name, server_name, database_name, schema_name, table_name, column_name, subscription_id		Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns).

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.
database_name	string	The name of the database. 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.
server_name	string	The name of the server. Required.
subscription_id	string
table_name	string	The name of the table. Required.
$count	boolean	Default value is None.
$filter	string	An OData filter expression that filters elements in the collection. Default value is None.
$skipToken	string	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,
clientClassificationSource,
columnName,
informationType,
informationTypeId,
isDisabled,
labelId,
labelName,
managedBy,
rank,
schemaName,
systemData,
tableName,
type
FROM azure.sql.sensitivity_labels
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_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_by_database

Gets the sensitivity labels of a given database.

SELECT
id,
name,
clientClassificationSource,
columnName,
informationType,
informationTypeId,
isDisabled,
labelId,
labelName,
managedBy,
rank,
schemaName,
systemData,
tableName,
type
FROM azure.sql.sensitivity_labels
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates or updates the sensitivity label of a given column.

INSERT INTO azure.sql.sensitivity_labels (
properties,
resource_group_name,
server_name,
database_name,
schema_name,
table_name,
column_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ database_name }}',
'{{ schema_name }}',
'{{ table_name }}',
'{{ column_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
managedBy,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sensitivity_labels
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sensitivity_labels resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the sensitivity_labels resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the sensitivity_labels resource.
  - name: schema_name
    value: "{{ schema_name }}"
    description: Required parameter for the sensitivity_labels resource.
  - name: table_name
    value: "{{ table_name }}"
    description: Required parameter for the sensitivity_labels resource.
  - name: column_name
    value: "{{ column_name }}"
    description: Required parameter for the sensitivity_labels resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sensitivity_labels resource.
  - name: properties
    description: |
      Resource properties.
    value:
      schemaName: "{{ schemaName }}"
      tableName: "{{ tableName }}"
      columnName: "{{ columnName }}"
      labelName: "{{ labelName }}"
      labelId: "{{ labelId }}"
      informationType: "{{ informationType }}"
      informationTypeId: "{{ informationTypeId }}"
      isDisabled: {{ isDisabled }}
      rank: "{{ rank }}"
      clientClassificationSource: "{{ clientClassificationSource }}"

UPDATE examples

update

Update sensitivity labels of a given database using an operations batch.

UPDATE azure.sql.sensitivity_labels
SET 
operations = '{{ operations }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required;

REPLACE examples

create_or_update

Creates or updates the sensitivity label of a given column.

REPLACE azure.sql.sensitivity_labels
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_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,
systemData,
type;

DELETE examples

delete

Deletes the sensitivity label of a given column.

DELETE FROM azure.sql.sensitivity_labels
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_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_recommended_by_database

Gets the sensitivity labels of a given database.

EXEC azure.sql.sensitivity_labels.list_recommended_by_database 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$skipToken='{{ $skipToken }}', 
@includeDisabledRecommendations={{ includeDisabledRecommendations }}, 
@$filter='{{ $filter }}'
;

list_current_by_database

Gets the sensitivity labels of a given database.

EXEC azure.sql.sensitivity_labels.list_current_by_database 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$skipToken='{{ $skipToken }}', 
@$count={{ $count }}, 
@$filter='{{ $filter }}'
;

disable_recommendation

Disables sensitivity recommendations on a given column.

EXEC azure.sql.sensitivity_labels.disable_recommendation 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@column_name='{{ column_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

enable_recommendation

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

EXEC azure.sql.sensitivity_labels.enable_recommendation 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@column_name='{{ column_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;