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

Successfully retrieved the sensitivity label.

Name	Datatype	Description
managedBy	string	Resource that manages the sensitivity label.
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource, subscriptionId		Gets the sensitivity label of a given column
create_or_update	insert	resourceGroupName, serverName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource, subscriptionId		Creates or updates the sensitivity label of a given column
update	update	resourceGroupName, serverName, databaseName, subscriptionId		Update sensitivity labels of a given database using an operations batch.
delete	delete	resourceGroupName, serverName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource, subscriptionId		Deletes the sensitivity label of a given column
enable_recommendation	exec	resourceGroupName, serverName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource, subscriptionId		Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)
disable_recommendation	exec	resourceGroupName, serverName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource, subscriptionId		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.
databaseName	string	The name of the database.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
schemaName	string	The name of the schema.
sensitivityLabelSource	string
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
tableName	string	The name of the table.

SELECT examples

get

Gets the sensitivity label of a given column

SELECT
managedBy,
properties
FROM azure.sql.sensitivity_labels
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND schemaName = '{{ schemaName }}' -- required
AND tableName = '{{ tableName }}' -- required
AND columnName = '{{ columnName }}' -- required
AND sensitivityLabelSource = '{{ sensitivityLabelSource }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the sensitivity label of a given column

INSERT INTO azure.sql.sensitivity_labels (
data__properties,
resourceGroupName,
serverName,
databaseName,
schemaName,
tableName,
columnName,
sensitivityLabelSource,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ schemaName }}',
'{{ tableName }}',
'{{ columnName }}',
'{{ sensitivityLabelSource }}',
'{{ subscriptionId }}'
RETURNING
managedBy,
properties
;

Manifest

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

UPDATE examples

update

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

UPDATE azure.sql.sensitivity_labels
SET 
data__operations = '{{ operations }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required;

DELETE examples

delete

Deletes the sensitivity label of a given column

DELETE FROM azure.sql.sensitivity_labels
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND schemaName = '{{ schemaName }}' --required
AND tableName = '{{ tableName }}' --required
AND columnName = '{{ columnName }}' --required
AND sensitivityLabelSource = '{{ sensitivityLabelSource }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

enable_recommendation

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

EXEC azure.sql.sensitivity_labels.enable_recommendation 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@schemaName='{{ schemaName }}' --required, 
@tableName='{{ tableName }}' --required, 
@columnName='{{ columnName }}' --required, 
@sensitivityLabelSource='{{ sensitivityLabelSource }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

disable_recommendation

Disables sensitivity recommendations on a given column

EXEC azure.sql.sensitivity_labels.disable_recommendation 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@schemaName='{{ schemaName }}' --required, 
@tableName='{{ tableName }}' --required, 
@columnName='{{ columnName }}' --required, 
@sensitivityLabelSource='{{ sensitivityLabelSource }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;