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

Data Masking Rules - List By Database

获取数据库数据掩码规则的列表。

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

URI 参数

名称 必需 类型 说明
databaseName
path True

string

数据库的名称。

dataMaskingPolicyName
path True

DataMaskingPolicyName

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

resourceGroupName
path True

string

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

serverName
path True

string

服务器的名称。

subscriptionId
path True

string

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

api-version
query True

string

要用于请求的 API 版本。

响应

名称 类型 说明
200 OK

DataMaskingRuleListResult

已成功检索服务器高级威胁防护状态的列表。

Other Status Codes

错误响应:***

示例

Gets a list of database data masking rules.

示例请求

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/rules?api-version=2021-11-01

示例响应

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

定义

名称 说明
DataMaskingFunction

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

DataMaskingPolicyName

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

DataMaskingRule

数据库数据掩码规则。

DataMaskingRuleListResult

数据库数据掩码规则的列表。

DataMaskingRuleState

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

DataMaskingFunction

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

名称 类型 说明
CCN

string

Default

string

Email

string

Number

string

SSN

string

Text

string

DataMaskingPolicyName

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

名称 类型 说明
Default

string

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 指定为 disabled。 但是,如果规则尚不存在,则将在 ruleState 设置为启用的情况下创建规则,而不考虑所提供的 ruleState 值。

properties.schemaName

string

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

properties.suffixSize

string

如果将 maskingFunction 设置为 Text,则表示在字符串末尾取消掩码显示的字符数。 否则,将忽略此参数。

properties.tableName

string

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

type

string

资源类型。

DataMaskingRuleListResult

数据库数据掩码规则的列表。

名称 类型 说明
nextLink

string

用于检索下一页结果的链接。

value

DataMaskingRule[]

结果数组。

DataMaskingRuleState

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

名称 类型 说明
Disabled

string

Enabled

string