Classification Rules - Get

Servizio:

Purview

Versione API:

2023-09-01

Ottiene una regola di classificazione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
classificationRuleName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nome della regola di classificazione.
endpoint	path	True	string (url)	Endpoint di analisi dell'account purview. Esempio: https://{accountName}.purview.azure.com.
api-version	query	True	string	Versione dell'API da usare.

Risposte

Nome	Tipo	Descrizione
200 OK	ClassificationRule: SystemClassificationRule CustomClassificationRule	Successo.
Other Status Codes	ErrorResponseModel	Risposta di errore ricevuta dal servizio di analisi. Intestazioni x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ClassificationRules_Get

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
ClassificationAction	Azione della regola di classificazione.
ClassificationRuleStatus	Stato della regola della regola di classificazione del sistema.
CustomClassificationRule	Regola di classificazione personalizzata.
CustomClassificationRuleProperties	Proprietà della regola di classificazione personalizzata.
ErrorModel	Modello di errore.
ErrorResponseModel	Modello di risposta di errore.
RegexClassificationRulePattern	Modello di regola di classificazione regex.
SystemClassificationRule	Regola di classificazione del sistema.
SystemClassificationRuleProperties	Proprietà della regola di classificazione del sistema.

ClassificationAction

Enumerazione

Azione della regola di classificazione.

Valore	Descrizione
Keep
Delete

ClassificationRuleStatus

Enumerazione

Stato della regola della regola di classificazione del sistema.

Valore	Descrizione
Enabled
Disabled

CustomClassificationRule

Object

Regola di classificazione personalizzata.

Nome	Tipo	Descrizione
id	string	Identificatore della risorsa.
kind	string: Custom	Tipo di regola di classificazione.
name	string	Nome della risorsa.
properties	CustomClassificationRuleProperties	Proprietà della regola di classificazione personalizzata.

CustomClassificationRuleProperties

Object

Proprietà della regola di classificazione personalizzata.

Nome	Tipo	Descrizione
classificationAction	ClassificationAction	Azione della regola di classificazione.
classificationName	string	Nome di classificazione della regola di classificazione personalizzata.
columnPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Modelli di colonna della regola di classificazione personalizzata.
createdAt	string (date-time)	Ora di creazione della regola di classificazione personalizzata.
dataPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Modelli di dati della regola di classificazione personalizzata.
description	string	Descrizione della regola di classificazione personalizzata.
lastModifiedAt	string (date-time)	Ora dell'ultima modifica della regola di classificazione personalizzata.
minimumPercentageMatch	number (double)
ruleStatus	ClassificationRuleStatus	Stato della regola della regola di classificazione personalizzata.
version	integer (int32)	Versione della regola di classificazione personalizzata.

ErrorModel

Object

Modello di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore univoco che identifica l'errore specifico.
details	ErrorModel[]	Matrice di oggetti ErrorModel annidati che fornisce dettagli aggiuntivi sull'errore.
message	string	Messaggio di errore leggibile che fornisce altri dettagli sull'errore.
target	string	Componente specifico a cui è associato l'errore.

ErrorResponseModel

Object

Modello di risposta di errore.

Nome	Tipo	Descrizione
error	ErrorModel	Modello di errore.

RegexClassificationRulePattern

Object

Modello di regola di classificazione regex.

Nome	Tipo	Descrizione
kind	string: Regex	Proprietà del modello di regola di classificazione.
pattern	string	Modello di regola di classificazione regex.

SystemClassificationRule

Object

Regola di classificazione del sistema.

Nome	Tipo	Descrizione
id	string	Identificatore della risorsa.
kind	string: System	Tipo di regola di classificazione.
name	string	Nome della risorsa.
properties	SystemClassificationRuleProperties	Proprietà della regola di classificazione del sistema.

SystemClassificationRuleProperties

Object

Proprietà della regola di classificazione del sistema.

Nome	Tipo	Descrizione
classificationName	string	Nome di classificazione della regola di classificazione del sistema.
createdAt	string (date-time)	Ora di creazione della regola di classificazione del sistema.
description	string
lastModifiedAt	string (date-time)	Ora dell'ultima modifica della regola di classificazione del sistema.
ruleStatus	ClassificationRuleStatus	Stato della regola della regola di classificazione del sistema.
version	integer (int32)	Versione della regola di classificazione del sistema.