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

Classification Rules - Get

参考

Service:: Purview

API Version:: 2023-09-01

获取分类规则。

GET {endpoint}/scan/classificationrules/{classificationRuleName}?api-version=2023-09-01

URI 参数

名称在必需类型说明

classificationRuleName

path

True

string

分类规则名称。

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

endpoint

path

True

string

url

purview 帐户的扫描终结点。示例：https://{accountName}.purview.azure.com。

api-version

query

True

string

要使用的 API 版本。

响应

名称

类型

说明

200 OK

ClassificationRule:

SystemClassificationRule
CustomClassificationRule

成功。

Other Status Codes

ErrorResponseModel

从扫描服务收到的错误响应。

Headers

x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

ClassificationRules_Get

Sample Request

HTTP

GET {endpoint}/scan/classificationrules/ClassificationRule1?api-version=2023-09-01

Sample Response

Status code:: 200

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

Response Body

{
  "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataCatalog/DataCatalogs/Catalog1/ClassificationRules/ClassificationRule1",
  "name": "ClassificationRule1",
  "kind": "Custom",
  "properties": {
    "minimumPercentageMatch": 80,
    "classificationAction": "Keep",
    "description": "second one",
    "version": 4,
    "classificationName": "CUSTOM.TEST.TWO",
    "ruleStatus": "Enabled",
    "createdAt": "2019-12-09T06:43:30.8478469Z",
    "lastModifiedAt": "2019-12-09T07:04:53.2807344Z",
    "dataPatterns": [
      {
        "kind": "Regex",
        "pattern": "^data1$"
      },
      {
        "kind": "Regex",
        "pattern": "^data2$"
      }
    ],
    "columnPatterns": [
      {
        "kind": "Regex",
        "pattern": "^column1$"
      }
    ]
  }
}

定义

名称	说明
ClassificationAction	分类规则的操作。
ClassificationRuleStatus	系统分类规则的规则状态。
CustomClassificationRule	自定义分类规则。
CustomClassificationRuleProperties	自定义分类规则的属性。
ErrorModel	错误模型。
ErrorResponseModel	错误响应模型。
RegexClassificationRulePattern	正则表达式分类规则的模式。
SystemClassificationRule	系统分类的规则。
SystemClassificationRuleProperties	系统分类规则的属性。

ClassificationAction

分类规则的操作。

名称	类型	说明
Delete	string
Keep	string

ClassificationRuleStatus

系统分类规则的规则状态。

名称	类型	说明
Disabled	string
Enabled	string

CustomClassificationRule

自定义分类规则。

名称	类型	说明
id	string	资源标识符。
kind	string: Custom	分类规则的类型。
name	string	资源名称。
properties	CustomClassificationRuleProperties	自定义分类规则的属性。

CustomClassificationRuleProperties

自定义分类规则的属性。

名称	类型	说明
classificationAction	ClassificationAction	分类规则的操作。
classificationName	string	自定义分类规则的分类名称。
columnPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	自定义分类规则的列模式。
createdAt	string	自定义分类规则的创建时间。
dataPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	自定义分类规则的数据模式。
description	string	自定义分类规则的说明。
lastModifiedAt	string	自定义分类规则的上次修改时间。
minimumPercentageMatch	number
ruleStatus	ClassificationRuleStatus	自定义分类规则的规则状态。
version	integer	自定义分类规则的版本。

ErrorModel

错误模型。

名称	类型	说明
code	string	标识特定错误的唯一错误代码。
details	ErrorModel[]	提供其他错误详细信息的嵌套 ErrorModel 对象的数组。
message	string	一条可读的错误消息，提供有关错误的更多详细信息。
target	string	与错误关联的特定组件。

ErrorResponseModel

错误响应模型。

名称	类型	说明
error	ErrorModel	错误模型。

RegexClassificationRulePattern

正则表达式分类规则的模式。

名称	类型	说明
kind	string: Regex	分类规则模式的属性。
pattern	string	正则表达式分类规则模式的模式。

SystemClassificationRule

系统分类的规则。

名称	类型	说明
id	string	资源标识符。
kind	string: System	分类规则的类型。
name	string	资源名称。
properties	SystemClassificationRuleProperties	系统分类规则的属性。

SystemClassificationRuleProperties

系统分类规则的属性。

名称	类型	说明
classificationName	string	系统分类规则的分类名称。
createdAt	string	系统分类规则的创建时间。
description	string
lastModifiedAt	string	系统分类规则的上次修改时间。
ruleStatus	ClassificationRuleStatus	系统分类规则的规则状态。
version	integer	系统分类规则的版本。