你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Data Masking Rules - Create Or Update

服务:: SQL Database

API 版本:: 2025-01-01

创建或更新数据库数据掩蔽规则。

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

URI 参数

名称	在	必需	类型	说明
databaseName	path	True	string	数据库的名称。
dataMaskingPolicyName	path	True	DataMaskingPolicyName	数据掩蔽策略适用的数据库名称。
dataMaskingRuleName	path	True	string	数据掩蔽规则的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure Resource Manager API 或门户获取此值。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

请求正文

名称	必需	类型	说明
properties.columnName	True	string	应用数据掩码规则的列名。
properties.maskingFunction	True	DataMaskingFunction	用于数据掩码规则的掩码函数。
properties.schemaName	True	string	应用数据掩码规则的架构名称。
properties.tableName	True	string	应用数据掩码规则的表名。
properties.aliasName		string	别名。这是一个旧参数，不再使用。
properties.numberFrom		string	掩码规则的 numberFrom 属性。如果 maskingFunction 设置为 Number，则是必需的，否则将忽略此参数。
properties.numberTo		string	数据掩码规则的 numberTo 属性。如果 maskingFunction 设置为 Number，则是必需的，否则将忽略此参数。
properties.prefixSize		string	如果 maskingFunction 设置为 Text，则表示在字符串开头未屏蔽的字符数。否则，将忽略此参数。
properties.replacementString		string	如果 maskingFunction 设置为 Text，则用于屏蔽字符串未公开部分的字符。否则，将忽略此参数。
properties.ruleState		DataMaskingRuleState	规则状态。用于删除规则。若要删除现有规则，请指定 schemaName、tableName、columnName、maskingFunction，并将 ruleState 指定为已禁用。但是，如果规则尚不存在，则将创建规则，并将 ruleState 设置为启用，而不考虑 ruleState 提供的值。
properties.suffixSize		string	如果 maskingFunction 设置为 Text，则表示在字符串末尾取消屏蔽的字符数。否则，将忽略此参数。

响应

名称	类型	说明
200 OK	DataMaskingRule	成功设置了一个数据库数据掩蔽规则。
201 Created	DataMaskingRule	成功创建了一个数据库数据掩蔽规则。
Other Status Codes	ErrorResponse	错误响应： *** 400 InvalidDatabaseNameForDataMaskingOperation - 无法直接对主数据库应用数据掩蔽策略和规则。数据掩蔽策略/规则仅适用于用户数据库。

名称

类型

说明

200 OK

DataMaskingRule

成功设置了一个数据库数据掩蔽规则。

201 Created

DataMaskingRule

成功创建了一个数据库数据掩蔽规则。

Other Status Codes

ErrorResponse

错误响应： ***

400 InvalidDatabaseNameForDataMaskingOperation - 无法直接对主数据库应用数据掩蔽策略和规则。数据掩蔽策略/规则仅适用于用户数据库。

示例

Create/Update data masking rule for default max.

Create/Update data masking rule for default min.

Create/Update data masking rule for numbers.

Create/Update data masking rule for text.

Create/Update data masking rule for default max.

示例请求

HTTP

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

{
  "properties": {
    "aliasName": "nickname",
    "schemaName": "dbo",
    "tableName": "Table_1",
    "columnName": "test1",
    "maskingFunction": "Default",
    "ruleState": "Enabled"
  }
}

示例响应

状态代码:: 200

{
  "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": "nickname",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "suffixSize": null,
    "replacementString": null
  }
}

状态代码:: 201

{
  "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": "nickname",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "suffixSize": null,
    "replacementString": null
  }
}

Create/Update data masking rule for default min.

示例请求

HTTP

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

{
  "properties": {
    "schemaName": "dbo",
    "tableName": "Table_1",
    "columnName": "test1",
    "maskingFunction": "Default"
  }
}

示例响应

状态代码:: 200

{
  "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": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "suffixSize": null,
    "replacementString": null
  }
}

状态代码:: 201

{
  "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": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "suffixSize": null,
    "replacementString": null
  }
}

Create/Update data masking rule for numbers.

示例请求

HTTP

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

{
  "properties": {
    "schemaName": "dbo",
    "tableName": "Table_1",
    "columnName": "test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2"
  }
}

示例响应

状态代码:: 200

{
  "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
  }
}

状态代码:: 201

{
  "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
  }
}

Create/Update data masking rule for text.

示例请求

HTTP

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

{
  "properties": {
    "schemaName": "dbo",
    "tableName": "Table_1",
    "columnName": "test1",
    "maskingFunction": "Text",
    "prefixSize": "1",
    "suffixSize": "0",
    "replacementString": "asdf"
  }
}

示例响应

状态代码:: 200

{
  "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"
  }
}

状态代码:: 201

{
  "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"
  }
}

定义

名称	说明
DataMaskingFunction	用于数据掩码规则的掩码函数。
DataMaskingPolicyName	数据掩蔽策略适用的数据库名称。
DataMaskingRule	数据库数据掩蔽规则。
DataMaskingRuleState	规则状态。用于删除规则。若要删除现有规则，请指定 schemaName、tableName、columnName、maskingFunction，并将 ruleState 指定为已禁用。但是，如果规则尚不存在，则将创建规则，并将 ruleState 设置为启用，而不考虑 ruleState 提供的值。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应

DataMaskingFunction

枚举

用于数据掩码规则的掩码函数。

值	说明
Default
CCN
Email
Number
SSN
Text

DataMaskingPolicyName

枚举

数据掩蔽策略适用的数据库名称。

值	说明
Default

DataMaskingRule

对象

数据库数据掩蔽规则。

名称	类型	说明
id	string	资源 ID。
kind	string	那种数据掩蔽规则。元数据，用于 Azure 门户。
location	string	数据掩蔽规则的位置。
name	string	资源名称。
properties.aliasName	string	别名。这是一个旧参数，不再使用。
properties.columnName	string	应用数据掩码规则的列名。
properties.id	string	规则是Id。
properties.maskingFunction	DataMaskingFunction	用于数据掩码规则的掩码函数。
properties.numberFrom	string	掩码规则的 numberFrom 属性。如果 maskingFunction 设置为 Number，则是必需的，否则将忽略此参数。
properties.numberTo	string	数据掩码规则的 numberTo 属性。如果 maskingFunction 设置为 Number，则是必需的，否则将忽略此参数。
properties.prefixSize	string	如果 maskingFunction 设置为 Text，则表示在字符串开头未屏蔽的字符数。否则，将忽略此参数。
properties.replacementString	string	如果 maskingFunction 设置为 Text，则用于屏蔽字符串未公开部分的字符。否则，将忽略此参数。
properties.ruleState	DataMaskingRuleState	规则状态。用于删除规则。若要删除现有规则，请指定 schemaName、tableName、columnName、maskingFunction，并将 ruleState 指定为已禁用。但是，如果规则尚不存在，则将创建规则，并将 ruleState 设置为启用，而不考虑 ruleState 提供的值。
properties.schemaName	string	应用数据掩码规则的架构名称。
properties.suffixSize	string	如果 maskingFunction 设置为 Text，则表示在字符串末尾取消屏蔽的字符数。否则，将忽略此参数。
properties.tableName	string	应用数据掩码规则的表名。
type	string	资源类型。

DataMaskingRuleState

枚举

规则状态。用于删除规则。若要删除现有规则，请指定 schemaName、tableName、columnName、maskingFunction，并将 ruleState 指定为已禁用。但是，如果规则尚不存在，则将创建规则，并将 ruleState 设置为启用，而不考虑 ruleState 提供的值。

值	说明
Enabled
Disabled

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

通过

Data Masking Rules - Create Or Update

URI 参数

请求正文

响应

示例

Create/Update data masking rule for default max.

示例请求

示例响应

Create/Update data masking rule for default min.

示例请求

示例响应

Create/Update data masking rule for numbers.

示例请求

示例响应

Create/Update data masking rule for text.

示例请求

示例响应

定义

DataMaskingFunction

DataMaskingPolicyName

DataMaskingRule

DataMaskingRuleState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse