data_masking_policies

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

Overview

Name	data_masking_policies
Type	Resource
Id	azure.synapse.data_masking_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
applicationPrincipals	string	The list of the application principals. This is a legacy parameter and is no longer used.
dataMaskingState	string	The state of the data masking policy. Known values are: "Disabled" and "Enabled".
exemptPrincipals	string	The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.
kind	string	The kind of data masking policy. Metadata, used for Azure portal.
location	string	The location of the data masking policy.
managedBy	string	Fully qualified resource ID of the sql pool.
maskingLevel	string	The masking level. This is a legacy parameter and is no longer used.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, sql_pool_name, subscription_id		Gets a Sql pool data masking policy.
create_or_update	insert	resource_group_name, workspace_name, sql_pool_name, subscription_id		Creates or updates a Sql pool data masking policy.
create_or_update	replace	resource_group_name, workspace_name, sql_pool_name, subscription_id		Creates or updates a Sql pool data masking policy.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Gets a Sql pool data masking policy.

SELECT
id,
name,
applicationPrincipals,
dataMaskingState,
exemptPrincipals,
kind,
location,
managedBy,
maskingLevel,
type
FROM azure.synapse.data_masking_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Sql pool data masking policy.

INSERT INTO azure.synapse.data_masking_policies (
properties,
resource_group_name,
workspace_name,
sql_pool_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ sql_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
managedBy,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_masking_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the data_masking_policies resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the data_masking_policies resource.
  - name: sql_pool_name
    value: "{{ sql_pool_name }}"
    description: Required parameter for the data_masking_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the data_masking_policies resource.
  - name: properties
    value:
      dataMaskingState: "{{ dataMaskingState }}"
      exemptPrincipals: "{{ exemptPrincipals }}"

REPLACE examples

create_or_update

Creates or updates a Sql pool data masking policy.

REPLACE azure.synapse.data_masking_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
kind,
location,
managedBy,
properties,
type;