Data Masking Policies - Get

Gets a database data masking policy.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/Default?api-version=2014-04-01

URI Parameters

Name In Required Type Description
databaseName
path True
  • string

The name of the database.

dataMaskingPolicyName
path True

The name of the database for which the data masking rule applies.

resourceGroupName
path True
  • string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName
path True
  • string

The name of the server.

subscriptionId
path True
  • string

The subscription ID that identifies an Azure subscription.

api-version
query True
  • string

The API version to use for the request.

Responses

Name Type Description
200 OK

OK

Examples

Get data masking policy

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default?api-version=2014-04-01

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies",
  "location": "Central US",
  "kind": null,
  "properties": {
    "dataMaskingState": "Enabled",
    "applicationPrincipals": "",
    "exemptPrincipals": "",
    "maskingLevel": ""
  }
}

Definitions

DataMaskingPolicy

Represents a database data masking policy.

DataMaskingPolicyName

The name of the database for which the data masking rule applies.

DataMaskingState

The state of the data masking policy.

DataMaskingPolicy

Represents a database data masking policy.

Name Type Description
id
  • string

Resource ID.

kind
  • string

The kind of data masking policy. Metadata, used for Azure portal.

location
  • string

The location of the data masking policy.

name
  • string

Resource name.

properties.applicationPrincipals
  • string

The list of the application principals. This is a legacy parameter and is no longer used.

properties.dataMaskingState

The state of the data masking policy.

properties.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.

properties.maskingLevel
  • string

The masking level. This is a legacy parameter and is no longer used.

type
  • string

Resource type.

DataMaskingPolicyName

The name of the database for which the data masking rule applies.

Name Type Description
Default
  • string

DataMaskingState

The state of the data masking policy.

Name Type Description
Disabled
  • string
Enabled
  • string