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

vw_data_masking_rules

Name	Datatype	Description
id	text	field from the properties object
alias_name	text	field from the properties object
column_name	text	field from the properties object
dataMaskingPolicyName	text	field from the properties object
dataMaskingRuleName	text	field from the properties object
kind	text	The kind of Data Masking Rule. Metadata, used for Azure portal.
location	text	The location of the data masking rule.
masking_function	text	field from the properties object
number_from	text	field from the properties object
number_to	text	field from the properties object
prefix_size	text	field from the properties object
replacement_string	text	field from the properties object
resourceGroupName	text	field from the properties object
rule_state	text	field from the properties object
schema_name	text	field from the properties object
sqlPoolName	text	field from the properties object
subscriptionId	text	field from the properties object
suffix_size	text	field from the properties object
table_name	text	field from the properties object
workspaceName	text	field from the properties object

data_masking_rules

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 a Sql pool data masking rule.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	dataMaskingPolicyName, dataMaskingRuleName, resourceGroupName, sqlPoolName, subscriptionId, workspaceName	Gets the specific Sql pool data masking rule.
list_by_sql_pool	SELECT	dataMaskingPolicyName, resourceGroupName, sqlPoolName, subscriptionId, workspaceName	Gets a list of Sql pool data masking rules.
create_or_update	INSERT	dataMaskingPolicyName, dataMaskingRuleName, resourceGroupName, sqlPoolName, subscriptionId, workspaceName	Creates or updates a Sql pool data masking rule.

SELECT examples

Gets a list of Sql pool data masking rules.

vw_data_masking_rules

SELECT
id,
alias_name,
column_name,
dataMaskingPolicyName,
dataMaskingRuleName,
kind,
location,
masking_function,
number_from,
number_to,
prefix_size,
replacement_string,
resourceGroupName,
rule_state,
schema_name,
sqlPoolName,
subscriptionId,
suffix_size,
table_name,
workspaceName
FROM azure.synapse.vw_data_masking_rules
WHERE dataMaskingPolicyName = '{{ dataMaskingPolicyName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND sqlPoolName = '{{ sqlPoolName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

data_masking_rules

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

INSERT example

Use the following StackQL query and manifest file to create a new data_masking_rules resource.

All Properties

/*+ create */
INSERT INTO azure.synapse.data_masking_rules (
dataMaskingPolicyName,
dataMaskingRuleName,
resourceGroupName,
sqlPoolName,
subscriptionId,
workspaceName,
properties
)
SELECT 
'{{ dataMaskingPolicyName }}',
'{{ dataMaskingRuleName }}',
'{{ resourceGroupName }}',
'{{ sqlPoolName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: id
          value: string
        - name: aliasName
          value: string
        - name: ruleState
          value: string
        - name: schemaName
          value: string
        - name: tableName
          value: string
        - name: columnName
          value: string
        - name: maskingFunction
          value: string
        - name: numberFrom
          value: string
        - name: numberTo
          value: string
        - name: prefixSize
          value: string
        - name: suffixSize
          value: string
        - name: replacementString
          value: string
    - name: location
      value: string
    - name: kind
      value: string