Classification Rules - Get

서비스:

Purview

API 버전:

2023-09-01

분류 규칙을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
classificationRuleName	path	True	string minLength: 3 maxLength: 63 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 버전입니다.

응답

Name	형식	Description
200 OK	ClassificationRule: SystemClassificationRule CustomClassificationRule	성공.
Other Status Codes	ErrorResponseModel	검색 서비스에서 받은 오류 응답입니다. 헤더 x-ms-error-code: string

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ClassificationRules_Get

샘플 요청

HTTP

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

샘플 응답

상태 코드:

200

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

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

정의

Name	Description
ClassificationAction	분류 규칙의 동작입니다.
ClassificationRuleStatus	시스템 분류 규칙의 규칙 상태입니다.
CustomClassificationRule	사용자 지정 분류 규칙입니다.
CustomClassificationRuleProperties	사용자 지정 분류 규칙의 속성입니다.
ErrorModel	오류 모델입니다.
ErrorResponseModel	오류 응답 모델입니다.
RegexClassificationRulePattern	regex 분류 규칙의 패턴입니다.
SystemClassificationRule	시스템 분류 규칙입니다.
SystemClassificationRuleProperties	시스템 분류 규칙의 속성입니다.

ClassificationAction

열거형

분류 규칙의 동작입니다.

값	Description
Keep
Delete

ClassificationRuleStatus

열거형

시스템 분류 규칙의 규칙 상태입니다.

값	Description
Enabled
Disabled

CustomClassificationRule

Object

사용자 지정 분류 규칙입니다.

Name	형식	Description
id	string	리소스 식별자입니다.
kind	string: Custom	분류 규칙의 종류입니다.
name	string	리소스 이름입니다.
properties	CustomClassificationRuleProperties	사용자 지정 분류 규칙의 속성입니다.

CustomClassificationRuleProperties

Object

사용자 지정 분류 규칙의 속성입니다.

Name	형식	Description
classificationAction	ClassificationAction	분류 규칙의 동작입니다.
classificationName	string	사용자 지정 분류 규칙의 분류 이름입니다.
columnPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	사용자 지정 분류 규칙의 열 패턴입니다.
createdAt	string (date-time)	사용자 지정 분류 규칙의 생성 시간입니다.
dataPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	사용자 지정 분류 규칙의 데이터 패턴입니다.
description	string	사용자 지정 분류 규칙에 대한 설명입니다.
lastModifiedAt	string (date-time)	사용자 지정 분류 규칙의 마지막으로 수정된 시간입니다.
minimumPercentageMatch	number (double)
ruleStatus	ClassificationRuleStatus	사용자 지정 분류 규칙의 규칙 상태입니다.
version	integer (int32)	사용자 지정 분류 규칙의 버전입니다.

ErrorModel

Object

오류 모델입니다.

Name	형식	Description
code	string	특정 오류를 식별하는 고유한 오류 코드입니다.
details	ErrorModel[]	추가 오류 세부 정보를 제공하는 중첩된 ErrorModel 개체의 배열입니다.
message	string	오류에 대한 자세한 내용을 제공하는 사람이 읽을 수 있는 오류 메시지입니다.
target	string	오류가 연결된 특정 구성 요소입니다.

ErrorResponseModel

Object

오류 응답 모델입니다.

Name	형식	Description
error	ErrorModel	오류 모델입니다.

RegexClassificationRulePattern

Object

regex 분류 규칙의 패턴입니다.

Name	형식	Description
kind	string: Regex	분류 규칙 패턴의 속성입니다.
pattern	string	regex 분류 규칙 패턴의 패턴입니다.

SystemClassificationRule

Object

시스템 분류 규칙입니다.

Name	형식	Description
id	string	리소스 식별자입니다.
kind	string: System	분류 규칙의 종류입니다.
name	string	리소스 이름입니다.
properties	SystemClassificationRuleProperties	시스템 분류 규칙의 속성입니다.

SystemClassificationRuleProperties

Object

시스템 분류 규칙의 속성입니다.

Name	형식	Description
classificationName	string	시스템 분류 규칙의 분류 이름입니다.
createdAt	string (date-time)	시스템 분류 규칙의 생성 시간입니다.
description	string
lastModifiedAt	string (date-time)	시스템 분류 규칙의 마지막으로 수정된 시간입니다.
ruleStatus	ClassificationRuleStatus	시스템 분류 규칙의 규칙 상태입니다.
version	integer (int32)	시스템 분류 규칙의 버전입니다.