Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The servers/databases/dataMaskingPolicies resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2022-11-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
dataMaskingState: 'string'
exemptPrincipals: 'string'
}
}
Property Values
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 |
Microsoft.Sql/servers/databases/dataMaskingPolicies
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'Default' (required) |
| 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: servers/databases |
| properties | Resource properties. | DataMaskingPolicyProperties |
ARM template resource definition
The servers/databases/dataMaskingPolicies resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2022-11-01-preview",
"name": "string",
"properties": {
"dataMaskingState": "string",
"exemptPrincipals": "string"
}
}
Property Values
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 |
Microsoft.Sql/servers/databases/dataMaskingPolicies
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-11-01-preview' |
| name | The resource name | 'Default' (required) |
| properties | Resource properties. | DataMaskingPolicyProperties |
| type | The resource type | 'Microsoft.Sql/servers/databases/dataMaskingPolicies' |
Usage Examples
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@2022-11-01-preview"
name = "string"
body = {
properties = {
dataMaskingState = "string"
exemptPrincipals = "string"
}
}
}
Property Values
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 |
Microsoft.Sql/servers/databases/dataMaskingPolicies
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'Default' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: servers/databases |
| properties | Resource properties. | DataMaskingPolicyProperties |
| type | The resource type | "Microsoft.Sql/servers/databases/dataMaskingPolicies@2022-11-01-preview" |