data_masking_rules

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

Overview

Name	data_masking_rules
Type	Resource
Id	azure.sql.data_masking_rules

Fields

The following fields are returned by SELECT queries:

list_by_database

Name	Datatype	Description
kind	string	The kind of Data Masking Rule. Metadata, used for Azure portal.
location	string	The location of the data masking rule.
properties	object	The properties of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_database	select	subscriptionId, resourceGroupName, serverName, databaseName, dataMaskingPolicyName		Gets a list of database data masking rules.
create_or_update	insert	subscriptionId, resourceGroupName, serverName, databaseName, dataMaskingPolicyName, dataMaskingRuleName		Creates or updates a database data masking rule.

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
dataMaskingPolicyName	string	The name of the database for which the data masking rule applies.
dataMaskingRuleName	string	The name of the data masking rule.
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.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

list_by_database

Gets a list of database data masking rules.

SELECT
kind,
location,
properties
FROM azure.sql.data_masking_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND dataMaskingPolicyName = '{{ dataMaskingPolicyName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a database data masking rule.

INSERT INTO azure.sql.data_masking_rules (
data__properties,
subscriptionId,
resourceGroupName,
serverName,
databaseName,
dataMaskingPolicyName,
dataMaskingRuleName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ dataMaskingPolicyName }}',
'{{ dataMaskingRuleName }}'
RETURNING
kind,
location,
properties
;

Manifest

# Description fields are for documentation purposes
- name: data_masking_rules
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the data_masking_rules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_masking_rules resource.
    - name: serverName
      value: string
      description: Required parameter for the data_masking_rules resource.
    - name: databaseName
      value: string
      description: Required parameter for the data_masking_rules resource.
    - name: dataMaskingPolicyName
      value: string
      description: Required parameter for the data_masking_rules resource.
    - name: dataMaskingRuleName
      value: string
      description: Required parameter for the data_masking_rules resource.
    - name: properties
      value: object
      description: |
        The properties of the resource.