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

Data Masking Rules - Create Or Update

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

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

URI 参数

Name In Required Type Description
databaseName
path True
  • string

数据库的名称。

dataMaskingPolicyName
path True

应用数据掩码规则的数据库的名称。

dataMaskingRuleName
path True
  • string

数据掩码规则的名称。

resourceGroupName
path True
  • string

包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。

serverName
path True
  • string

服务器的名称。

subscriptionId
path True
  • string

用于标识 Azure 订阅的订阅 ID。

api-version
query True
  • string

要用于请求的 API 版本。

请求正文

Name Required Type Description
properties.columnName True
  • string

应用数据掩码规则的列名。

properties.maskingFunction True

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

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

规则状态。 用于删除规则。 若要删除现有规则,请指定 schemaName、tableName、columnName、maskingFunction,并将 ruleState 指定为禁用状态。 但是,如果规则尚不存在,则无论 ruleState 提供的值如何,都将使用 ruleState 设置为启用的规则创建规则。

properties.suffixSize
  • string

如果将 maskingFunction 设置为 Text,则表示在字符串末尾未屏蔽的字符数。 否则,将忽略此参数。

响应

Name Type Description
200 OK

OK

201 Created

创建

示例

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

Sample Request

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=2014-04-01

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

Sample Response

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

Sample Request

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=2014-04-01

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

Sample Response

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

Sample Request

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=2014-04-01

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

Sample Response

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

Sample Request

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=2014-04-01

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

Sample Response

{
  "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": "Text",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": "1",
    "suffixSize": "0",
    "replacementString": "asdf"
  }
}

定义

DataMaskingFunction

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

DataMaskingPolicyName

应用数据掩码规则的数据库的名称。

DataMaskingRule

表示数据库数据掩码规则。

DataMaskingRuleState

规则状态。 用于删除规则。 若要删除现有规则,请指定 schemaName、tableName、columnName、maskingFunction,并将 ruleState 指定为禁用状态。 但是,如果规则尚不存在,则无论 ruleState 提供的值如何,都将使用 ruleState 设置为启用的规则创建规则。

DataMaskingFunction

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

Name Type Description
CCN
  • string
Default
  • string
Email
  • string
Number
  • string
SSN
  • string
Text
  • string

DataMaskingPolicyName

应用数据掩码规则的数据库的名称。

Name Type Description
Default
  • string

DataMaskingRule

表示数据库数据掩码规则。

Name Type Description
id
  • string

资源 ID。

kind
  • string

数据掩码规则的类型。 元数据,用于Azure 门户。

location
  • string

数据掩码规则的位置。

name
  • string

资源名称。

properties.aliasName
  • string

别名。 这是一个旧参数,不再使用。

properties.columnName
  • string

应用数据掩码规则的列名。

properties.id
  • string

规则 ID。

properties.maskingFunction

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

properties.numberFrom
  • string

掩码规则的 numberFrom 属性。 如果 maskingFunction 设置为 Number,则是必需的,否则将忽略此参数。

properties.numberTo
  • string

数据掩码规则的 numberTo 属性。 如果 maskingFunction 设置为 Number,则是必需的,否则将忽略此参数。

properties.prefixSize
  • string

如果 maskingFunction 设置为 Text,则表示在字符串开头未屏蔽的字符数。 否则,将忽略此参数。

properties.replacementString
  • string

如果将 maskingFunction 设置为 Text,则用于屏蔽字符串未公开部分的字符。 否则,将忽略此参数。

properties.ruleState

规则状态。 用于删除规则。 若要删除现有规则,请指定 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 设置为启用的规则创建规则。

Name Type Description
Disabled
  • string
Enabled
  • string