Classification Rules - Get

Referenz

Service:: Purview

API Version:: 2023-09-01

Ruft eine Klassifizierungsregel ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung

classificationRuleName

path

True

string

Der Name der Klassifizierungsregel.

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

endpoint

path

True

string

url

Der Scanendpunkt Ihres Purview-Kontos. Beispiel: https://{accountName}.purview.azure.com.

api-version

query

True

string

Die zu verwendende API-Version.

Antworten

Name

Typ

Beschreibung

200 OK

ClassificationRule:

SystemClassificationRule
CustomClassificationRule

Erfolg.

Other Status Codes

ErrorResponseModel

Eine Vom Überprüfungsdienst empfangene Fehlerantwort.

Headers

x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
ClassificationAction	Die Aktion der Klassifizierungsregel.
ClassificationRuleStatus	Die Regel status der Systemklassifizierungsregel.
CustomClassificationRule	Regel der benutzerdefinierten Klassifizierung.
CustomClassificationRuleProperties	Die Eigenschaften der benutzerdefinierten Klassifizierungsregel.
ErrorModel	Das Fehlermodell.
ErrorResponseModel	Das Fehlerantwortmodell.
RegexClassificationRulePattern	Muster der RegEx-Klassifizierungsregel.
SystemClassificationRule	Die Regel der Systemklassifizierung.
SystemClassificationRuleProperties	Die Eigenschaften der Systemklassifizierungsregel.

ClassificationAction

Die Aktion der Klassifizierungsregel.

Name	Typ	Beschreibung
Delete	string
Keep	string

ClassificationRuleStatus

Die Regel status der Systemklassifizierungsregel.

Name	Typ	Beschreibung
Disabled	string
Enabled	string

CustomClassificationRule

Regel der benutzerdefinierten Klassifizierung.

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.
kind	string: Custom	Die Art der Klassifizierungsregel.
name	string	Der Name der Ressource.
properties	CustomClassificationRuleProperties	Die Eigenschaften der benutzerdefinierten Klassifizierungsregel.

CustomClassificationRuleProperties

Die Eigenschaften der benutzerdefinierten Klassifizierungsregel.

Name	Typ	Beschreibung
classificationAction	ClassificationAction	Die Aktion der Klassifizierungsregel.
classificationName	string	Der Klassifizierungsname der benutzerdefinierten Klassifizierungsregel.
columnPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Die Spaltenmuster der benutzerdefinierten Klassifizierungsregel.
createdAt	string	Der Erstellungszeitpunkt der benutzerdefinierten Klassifizierungsregel.
dataPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Die Datenmuster der benutzerdefinierten Klassifizierungsregel.
description	string	Die Beschreibung der benutzerdefinierten Klassifizierungsregel.
lastModifiedAt	string	Der Zeitpunkt der letzten Änderung der benutzerdefinierten Klassifizierungsregel.
minimumPercentageMatch	number
ruleStatus	ClassificationRuleStatus	Die Regel status der benutzerdefinierten Klassifizierungsregel.
version	integer	Die Version der benutzerdefinierten Klassifizierungsregel.

ErrorModel

Das Fehlermodell.

Name	Typ	Beschreibung
code	string	Ein eindeutiger Fehlercode, der den spezifischen Fehler identifiziert.
details	ErrorModel[]	Ein Array geschachtelter ErrorModel-Objekte, das zusätzliche Fehlerdetails bereitstellt.
message	string	Eine lesbare Fehlermeldung, die weitere Details zum Fehler enthält.
target	string	Die spezifische Komponente, der der Fehler zugeordnet ist.

ErrorResponseModel

Das Fehlerantwortmodell.

Name	Typ	Beschreibung
error	ErrorModel	Das Fehlermodell.

RegexClassificationRulePattern

Muster der RegEx-Klassifizierungsregel.

Name	Typ	Beschreibung
kind	string: Regex	Die Eigenschaften des Klassifizierungsregelmusters.
pattern	string	Das Muster des Regelregelmusters für die RegEx-Klassifizierung.

SystemClassificationRule

Die Regel der Systemklassifizierung.

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.
kind	string: System	Die Art der Klassifizierungsregel.
name	string	Der Name der Ressource.
properties	SystemClassificationRuleProperties	Die Eigenschaften der Systemklassifizierungsregel.

SystemClassificationRuleProperties

Die Eigenschaften der Systemklassifizierungsregel.

Name	Typ	Beschreibung
classificationName	string	Der Klassifizierungsname der Systemklassifizierungsregel.
createdAt	string	Der Erstellungszeitpunkt der Systemklassifizierungsregel.
description	string
lastModifiedAt	string	Der Zeitpunkt der letzten Änderung der Systemklassifizierungsregel.
ruleStatus	ClassificationRuleStatus	Die Regel status der Systemklassifizierungsregel.
version	integer	Die Version der Systemklassifizierungsregel.