Share via

Microsoft.Sql servers/databases/dataMaskingPolicies 2023-02-01-preview

  • Article

Bicep resource definition

The servers/databases/dataMaskingPolicies resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/servers/databases/dataMaskingPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Sql/servers/databases/dataMaskingPolicies@2023-02-01-preview' = {
  name: 'Default'
  parent: resourceSymbolicName
  properties: {
    dataMaskingState: 'string'
    exemptPrincipals: 'string'
  }
}

Property values

servers/databases/dataMaskingPolicies

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 'Default'
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: databases
properties Resource properties. DataMaskingPolicyProperties

DataMaskingPolicyProperties

Name Description Value
dataMaskingState The state of the data masking policy. 'Disabled'
'Enabled' (required)
exemptPrincipals 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. string

ARM template resource definition

The servers/databases/dataMaskingPolicies resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/servers/databases/dataMaskingPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies",
  "apiVersion": "2023-02-01-preview",
  "name": "Default",
  "properties": {
    "dataMaskingState": "string",
    "exemptPrincipals": "string"
  }
}

Property values

servers/databases/dataMaskingPolicies

Name Description Value
type The resource type 'Microsoft.Sql/servers/databases/dataMaskingPolicies'
apiVersion The resource api version '2023-02-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 'Default'
properties Resource properties. DataMaskingPolicyProperties

DataMaskingPolicyProperties

Name Description Value
dataMaskingState The state of the data masking policy. 'Disabled'
'Enabled' (required)
exemptPrincipals 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. string

Terraform (AzAPI provider) resource definition

The servers/databases/dataMaskingPolicies resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/servers/databases/dataMaskingPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/databases/dataMaskingPolicies@2023-02-01-preview"
  name = "Default"
  parent_id = "string"
  body = jsonencode({
    properties = {
      dataMaskingState = "string"
      exemptPrincipals = "string"
    }
  })
}

Property values

servers/databases/dataMaskingPolicies

Name Description Value
type The resource type "Microsoft.Sql/servers/databases/dataMaskingPolicies@2023-02-01-preview"
name The resource name "Default"
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databases
properties Resource properties. DataMaskingPolicyProperties

DataMaskingPolicyProperties

Name Description Value
dataMaskingState The state of the data masking policy. "Disabled"
"Enabled" (required)
exemptPrincipals 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. string