Classification Rules - Get

Tjänst:

Purview

API-version:

2023-09-01

Hämtar en klassificeringsregel.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
classificationRuleName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Namnet på klassificeringsregeln.
endpoint	path	True	string (url)	Genomsökningsslutpunkten för ditt purview-konto. Exempel: https://{accountName}.purview.azure.com.
api-version	query	True	string	Api-versionen som ska användas.

Svar

Name	Typ	Description
200 OK	ClassificationRule: SystemClassificationRule CustomClassificationRule	Framgång.
Other Status Codes	ErrorResponseModel	Ett felsvar som togs emot från genomsökningstjänsten. Sidhuvuden x-ms-error-code: string

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ClassificationRules_Get

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ClassificationAction	Klassificeringsregelns åtgärd.
ClassificationRuleStatus	Regelstatus för systemklassificeringsregeln.
CustomClassificationRule	Regel för anpassad klassificering.
CustomClassificationRuleProperties	Egenskaperna för den anpassade klassificeringsregeln.
ErrorModel	Felmodellen.
ErrorResponseModel	Felsvarsmodellen.
RegexClassificationRulePattern	Mönster för regex-klassificeringsregel.
SystemClassificationRule	Regeln för systemklassificering.
SystemClassificationRuleProperties	Egenskaperna för systemklassificeringsregeln.

ClassificationAction

Uppräkning

Klassificeringsregelns åtgärd.

Värde	Description
Keep
Delete

ClassificationRuleStatus

Uppräkning

Regelstatus för systemklassificeringsregeln.

Värde	Description
Enabled
Disabled

CustomClassificationRule

Objekt

Regel för anpassad klassificering.

Name	Typ	Description
id	string	Resursidentifieraren.
kind	string: Custom	Typ av klassificeringsregel.
name	string	Resursnamnet.
properties	CustomClassificationRuleProperties	Egenskaperna för den anpassade klassificeringsregeln.

CustomClassificationRuleProperties

Objekt

Egenskaperna för den anpassade klassificeringsregeln.

Name	Typ	Description
classificationAction	ClassificationAction	Klassificeringsregelns åtgärd.
classificationName	string	Klassificeringsnamnet för den anpassade klassificeringsregeln.
columnPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Kolumnmönstren för anpassad klassificeringsregel.
createdAt	string (date-time)	Skapa tid för anpassad klassificeringsregel.
dataPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Datamönstren för anpassad klassificeringsregel.
description	string	Beskrivningen av en anpassad klassificeringsregel.
lastModifiedAt	string (date-time)	Den senaste ändrade tiden för den anpassade klassificeringsregeln.
minimumPercentageMatch	number (double)
ruleStatus	ClassificationRuleStatus	Regelstatus för anpassad klassificeringsregel.
version	integer (int32)	Versionen av den anpassade klassificeringsregeln.

ErrorModel

Objekt

Felmodellen.

Name	Typ	Description
code	string	En unik felkod som identifierar det specifika felet.
details	ErrorModel[]	En matris med kapslade ErrorModel-objekt som innehåller ytterligare felinformation.
message	string	Ett felmeddelande som kan läsas av människor och som innehåller mer information om felet.
target	string	Den specifika komponent som felet är associerat med.

ErrorResponseModel

Objekt

Felsvarsmodellen.

Name	Typ	Description
error	ErrorModel	Felmodellen.

RegexClassificationRulePattern

Objekt

Mönster för regex-klassificeringsregel.

Name	Typ	Description
kind	string: Regex	Egenskaperna för klassificeringsregelmönstret.
pattern	string	Mönster för regex-klassificeringsregelmönster.

SystemClassificationRule

Objekt

Regeln för systemklassificering.

Name	Typ	Description
id	string	Resursidentifieraren.
kind	string: System	Typ av klassificeringsregel.
name	string	Resursnamnet.
properties	SystemClassificationRuleProperties	Egenskaperna för systemklassificeringsregeln.

SystemClassificationRuleProperties

Objekt

Egenskaperna för systemklassificeringsregeln.

Name	Typ	Description
classificationName	string	Klassificeringsnamnet för systemklassificeringsregeln.
createdAt	string (date-time)	Skapandetiden för systemklassificeringsregeln.
description	string
lastModifiedAt	string (date-time)	Den senaste ändrade tiden för systemklassificeringsregeln.
ruleStatus	ClassificationRuleStatus	Regelstatus för systemklassificeringsregeln.
version	integer (int32)	Versionen av systemklassificeringsregeln.