managed_database_sensitivity_labels

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

Overview

Name	managed_database_sensitivity_labels
Type	Resource
Id	azure.sql.managed_database_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, managedInstanceName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource, subscriptionId		Gets the sensitivity label of a given column
create_or_update	insert	resourceGroupName, managedInstanceName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource, subscriptionId		Creates or updates the sensitivity label of a given column
update	update	resourceGroupName, managedInstanceName, databaseName, subscriptionId		Update sensitivity labels of a given database using an operations batch.
delete	delete	resourceGroupName, managedInstanceName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource, subscriptionId		Deletes the sensitivity label of a given column
disable_recommendation	exec	resourceGroupName, managedInstanceName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource, subscriptionId		Disables sensitivity recommendations on a given column
enable_recommendation	exec	resourceGroupName, managedInstanceName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource, subscriptionId		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
columnName	string	The name of the column.
databaseName	string	The name of the database.
managedInstanceName	string	The name of the managed instance.
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
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.managed_database_sensitivity_labels
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- 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.managed_database_sensitivity_labels (
data__properties,
resourceGroupName,
managedInstanceName,
databaseName,
schemaName,
tableName,
columnName,
sensitivityLabelSource,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ databaseName }}',
'{{ schemaName }}',
'{{ tableName }}',
'{{ columnName }}',
'{{ sensitivityLabelSource }}',
'{{ subscriptionId }}'
RETURNING
managedBy,
properties
;

Manifest

# Description fields are for documentation purposes
- name: managed_database_sensitivity_labels
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_database_sensitivity_labels resource.
    - name: managedInstanceName
      value: string
      description: Required parameter for the managed_database_sensitivity_labels resource.
    - name: databaseName
      value: string
      description: Required parameter for the managed_database_sensitivity_labels resource.
    - name: schemaName
      value: string
      description: Required parameter for the managed_database_sensitivity_labels resource.
    - name: tableName
      value: string
      description: Required parameter for the managed_database_sensitivity_labels resource.
    - name: columnName
      value: string
      description: Required parameter for the managed_database_sensitivity_labels resource.
    - name: sensitivityLabelSource
      value: string
      description: Required parameter for the managed_database_sensitivity_labels resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the managed_database_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.managed_database_sensitivity_labels
SET 
data__operations = '{{ operations }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND managedInstanceName = '{{ managedInstanceName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required;

DELETE examples

delete

Deletes the sensitivity label of a given column

DELETE FROM azure.sql.managed_database_sensitivity_labels
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND managedInstanceName = '{{ managedInstanceName }}' --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

disable_recommendation

Disables sensitivity recommendations on a given column

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

enable_recommendation

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

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