Classification Rules - Get

Usługa:

Purview

Wersja interfejsu API:

2023-09-01

Pobiera regułę klasyfikacji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
classificationRuleName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nazwa reguły klasyfikacji.
endpoint	path	True	string (url)	Punkt końcowy skanowania konta usługi purview. Przykład: https://{accountName}.purview.azure.com.
api-version	query	True	string	Wersja interfejsu API do użycia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ClassificationRule: SystemClassificationRule CustomClassificationRule	Sukces.
Other Status Codes	ErrorResponseModel	Odebrano odpowiedź o błędzie z usługi skanowania. Nagłówki x-ms-error-code: string

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ClassificationRules_Get

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
ClassificationAction	Akcja reguły klasyfikacji.
ClassificationRuleStatus	Stan reguły reguły klasyfikacji systemu.
CustomClassificationRule	Reguła klasyfikacji niestandardowej.
CustomClassificationRuleProperties	Właściwości reguły klasyfikacji niestandardowej.
ErrorModel	Model błędu.
ErrorResponseModel	Model odpowiedzi na błędy.
RegexClassificationRulePattern	Wzorzec reguły klasyfikacji regularnej.
SystemClassificationRule	Reguła klasyfikacji systemu.
SystemClassificationRuleProperties	Właściwości reguły klasyfikacji systemu.

ClassificationAction

Wyliczanie

Akcja reguły klasyfikacji.

Wartość	Opis
Keep
Delete

ClassificationRuleStatus

Wyliczanie

Stan reguły reguły klasyfikacji systemu.

Wartość	Opis
Enabled
Disabled

CustomClassificationRule

Objekt

Reguła klasyfikacji niestandardowej.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string: Custom	Rodzaj reguły klasyfikacji.
name	string	Nazwa zasobu.
properties	CustomClassificationRuleProperties	Właściwości reguły klasyfikacji niestandardowej.

CustomClassificationRuleProperties

Objekt

Właściwości reguły klasyfikacji niestandardowej.

Nazwa	Typ	Opis
classificationAction	ClassificationAction	Akcja reguły klasyfikacji.
classificationName	string	Nazwa klasyfikacji reguły klasyfikacji niestandardowej.
columnPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Wzorce kolumn niestandardowej reguły klasyfikacji.
createdAt	string (date-time)	Czas tworzenia niestandardowej reguły klasyfikacji.
dataPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Wzorce danych niestandardowej reguły klasyfikacji.
description	string	Opis niestandardowej reguły klasyfikacji.
lastModifiedAt	string (date-time)	Czas ostatniej modyfikacji niestandardowej reguły klasyfikacji.
minimumPercentageMatch	number (double)
ruleStatus	ClassificationRuleStatus	Stan reguły niestandardowej reguły klasyfikacji.
version	integer (int32)	Wersja reguły klasyfikacji niestandardowej.

ErrorModel

Objekt

Model błędu.

Nazwa	Typ	Opis
code	string	Unikatowy kod błędu identyfikujący określony błąd.
details	ErrorModel[]	Tablica zagnieżdżonych obiektów ErrorModel, która zawiera dodatkowe szczegóły błędu.
message	string	Czytelny dla człowieka komunikat o błędzie, który zawiera więcej szczegółów na temat błędu.
target	string	Określony składnik, z którymi jest skojarzony błąd.

ErrorResponseModel

Objekt

Model odpowiedzi na błędy.

Nazwa	Typ	Opis
error	ErrorModel	Model błędu.

RegexClassificationRulePattern

Objekt

Wzorzec reguły klasyfikacji regularnej.

Nazwa	Typ	Opis
kind	string: Regex	Właściwości wzorca reguły klasyfikacji.
pattern	string	Wzorzec reguły klasyfikacji regularnej.

SystemClassificationRule

Objekt

Reguła klasyfikacji systemu.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string: System	Rodzaj reguły klasyfikacji.
name	string	Nazwa zasobu.
properties	SystemClassificationRuleProperties	Właściwości reguły klasyfikacji systemu.

SystemClassificationRuleProperties

Objekt

Właściwości reguły klasyfikacji systemu.

Nazwa	Typ	Opis
classificationName	string	Nazwa klasyfikacji reguły klasyfikacji systemu.
createdAt	string (date-time)	Czas tworzenia reguły klasyfikacji systemu.
description	string
lastModifiedAt	string (date-time)	Czas ostatniej modyfikacji reguły klasyfikacji systemu.
ruleStatus	ClassificationRuleStatus	Stan reguły reguły klasyfikacji systemu.
version	integer (int32)	Wersja reguły klasyfikacji systemu.