Data Masking Rules - List By Database
Gets a list of database data masking rules.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/Default/rules?api-version=2021-11-01
Name | In | Required | Type | Description |
---|---|---|---|---|
database
|
path | True |
string |
The name of the database. |
data
|
path | True |
The name of the database for which the data masking rule applies. |
|
resource
|
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. |
server
|
path | True |
string |
The name of the server. |
subscription
|
path | True |
string |
The subscription ID that identifies an Azure subscription. |
api-version
|
query | True |
string |
The API version to use for the request. |
Name | Type | Description |
---|---|---|
200 OK |
Successfully retrieved the list of server's Advanced Threat Protection states. |
|
Other Status Codes |
*** Error Responses: *** |
Sample request
Sample response
{
"value": [
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/",
"name": null,
"type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
"location": "Central US",
"kind": null,
"properties": {
"id": "dbo_Table_1_test1",
"ruleState": "Enabled",
"schemaName": "dbo",
"tableName": "Table_1",
"columnName": "test1",
"aliasName": null,
"maskingFunction": "Text",
"numberFrom": null,
"numberTo": null,
"prefixSize": "1",
"suffixSize": "0",
"replacementString": "asdf"
}
},
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/",
"name": null,
"type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
"location": "Central US",
"kind": null,
"properties": {
"id": "dbo_Table_1_test1",
"ruleState": "Enabled",
"schemaName": "dbo",
"tableName": "Table_1",
"columnName": "test1",
"aliasName": null,
"maskingFunction": "Number",
"numberFrom": "0",
"numberTo": "2",
"prefixSize": null,
"suffixSize": null,
"replacementString": null
}
}
]
}
Name | Description |
---|---|
Data |
The masking function that is used for the data masking rule. |
Data |
The name of the database for which the data masking rule applies. |
Data |
A database data masking rule. |
Data |
The list of database data masking rules. |
Data |
The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. |
The masking function that is used for the data masking rule.
Name | Type | Description |
---|---|---|
CCN |
string |
|
Default |
string |
|
string |
||
Number |
string |
|
SSN |
string |
|
Text |
string |
The name of the database for which the data masking rule applies.
Name | Type | Description |
---|---|---|
Default |
string |
A database data masking rule.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
kind |
string |
The kind of Data Masking Rule. Metadata, used for Azure portal. |
location |
string |
The location of the data masking rule. |
name |
string |
Resource name. |
properties.aliasName |
string |
The alias name. This is a legacy parameter and is no longer used. |
properties.columnName |
string |
The column name on which the data masking rule is applied. |
properties.id |
string |
The rule Id. |
properties.maskingFunction |
The masking function that is used for the data masking rule. |
|
properties.numberFrom |
string |
The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. |
properties.numberTo |
string |
The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. |
properties.prefixSize |
string |
If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored. |
properties.replacementString |
string |
If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored. |
properties.ruleState |
The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. |
|
properties.schemaName |
string |
The schema name on which the data masking rule is applied. |
properties.suffixSize |
string |
If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored. |
properties.tableName |
string |
The table name on which the data masking rule is applied. |
type |
string |
Resource type. |
The list of database data masking rules.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link to retrieve next page of results. |
value |
Array of results. |
The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |