data_masking_rules

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

Overview

Name	data_masking_rules
Type	Resource
Id	azure.synapse.data_masking_rules

Fields

The following fields are returned by SELECT queries:

get

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.

list_by_sql_pool

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
get	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, dataMaskingPolicyName, dataMaskingRuleName		Gets the specific Sql pool data masking rule.
list_by_sql_pool	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, dataMaskingPolicyName		Gets a list of Sql pool data masking rules.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, dataMaskingPolicyName, dataMaskingRuleName		Creates or updates a Sql pool 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 data masking policy for which the masking rule applies.
dataMaskingRuleName	string	The name of the data masking rule.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sqlPoolName	string	SQL pool name
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets the specific Sql pool data masking rule.

SELECT
kind,
location,
properties
FROM azure.synapse.data_masking_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND dataMaskingPolicyName = '{{ dataMaskingPolicyName }}' -- required
AND dataMaskingRuleName = '{{ dataMaskingRuleName }}' -- required
;

list_by_sql_pool

Gets a list of Sql pool data masking rules.

SELECT
kind,
location,
properties
FROM azure.synapse.data_masking_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND dataMaskingPolicyName = '{{ dataMaskingPolicyName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Sql pool data masking rule.

INSERT INTO azure.synapse.data_masking_rules (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sqlPoolName,
dataMaskingPolicyName,
dataMaskingRuleName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sqlPoolName }}',
'{{ 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: workspaceName
      value: string
      description: Required parameter for the data_masking_rules resource.
    - name: sqlPoolName
      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.