Classification Rules - Get

Dienst:

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 minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Der Name der Klassifizierungsregel.
endpoint	path	True	string (url)	Der Überprüfungsendpunkt 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 Scandienst empfangene Fehlerantwort. Header x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ClassificationRules_Get

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

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

ClassificationAction

Enumeration

Die Aktion der Klassifizierungsregel.

Wert	Beschreibung
Keep
Delete

ClassificationRuleStatus

Enumeration

Der Regelstatus der Systemklassifizierungsregel.

Wert	Beschreibung
Enabled
Disabled

CustomClassificationRule

Objekt

Regel der benutzerdefinierten Klassifizierung.

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

CustomClassificationRuleProperties

Objekt

Die Eigenschaften einer benutzerdefinierten Klassifizierungsregel.

Name	Typ	Beschreibung
classificationAction	ClassificationAction	Die Aktion der Klassifizierungsregel.
classificationName	string	Der Klassifizierungsname der benutzerdefinierten Klassifizierungsregel.
columnPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Die Spaltenmuster einer benutzerdefinierten Klassifizierungsregel.
createdAt	string (date-time)	Die Erstellungszeit der benutzerdefinierten Klassifizierungsregel.
dataPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Die Datenmuster einer benutzerdefinierten Klassifizierungsregel.
description	string	Die Beschreibung der benutzerdefinierten Klassifizierungsregel.
lastModifiedAt	string (date-time)	Der Zeitpunkt der letzten Änderung der benutzerdefinierten Klassifizierungsregel.
minimumPercentageMatch	number (double)
ruleStatus	ClassificationRuleStatus	Der Regelstatus der benutzerdefinierten Klassifizierungsregel.
version	integer (int32)	Die Version der benutzerdefinierten Klassifizierungsregel.

ErrorModel

Objekt

Das Fehlermodell.

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

ErrorResponseModel

Objekt

Das Fehlerantwortmodell.

Name	Typ	Beschreibung
error	ErrorModel	Das Fehlermodell.

RegexClassificationRulePattern

Objekt

Muster der Regex-Klassifizierungsregel.

Name	Typ	Beschreibung
kind	string: Regex	Die Eigenschaften des Klassifizierungsregelmusters.
pattern	string	Das Muster der Regex-Klassifizierungsregelmuster.

SystemClassificationRule

Objekt

Die Regel der Systemklassifizierung.

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

SystemClassificationRuleProperties

Objekt

Die Eigenschaften der Systemklassifizierungsregel.

Name	Typ	Beschreibung
classificationName	string	Der Klassifizierungsname der Systemklassifizierungsregel.
createdAt	string (date-time)	Die Erstellungszeit der Systemklassifizierungsregel.
description	string
lastModifiedAt	string (date-time)	Der Zeitpunkt der letzten Änderung der Systemklassifizierungsregel.
ruleStatus	ClassificationRuleStatus	Der Regelstatus der Systemklassifizierungsregel.
version	integer (int32)	Die Version der Systemklassifizierungsregel.