Classification Rules - Get

Service:

Purview

Version d'API:

2023-09-01

Obtient une règle de classification.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
classificationRuleName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nom de la règle de classification.
endpoint	path	True	string (url)	Point de terminaison d’analyse de votre compte Purview. Exemple : https://{accountName}.purview.azure.com.
api-version	query	True	string	Version de l’API à utiliser.

Réponses

Nom	Type	Description
200 OK	ClassificationRule: SystemClassificationRule CustomClassificationRule	Succès.
Other Status Codes	ErrorResponseModel	Réponse d’erreur reçue du service d’analyse. En-têtes x-ms-error-code: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

ClassificationRules_Get

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
ClassificationAction	Action de la règle de classification.
ClassificationRuleStatus	État de la règle de classification système.
CustomClassificationRule	Règle de classification personnalisée.
CustomClassificationRuleProperties	Propriétés de la règle de classification personnalisée.
ErrorModel	Modèle d’erreur.
ErrorResponseModel	Modèle de réponse d’erreur.
RegexClassificationRulePattern	Modèle de règle de classification regex.
SystemClassificationRule	Règle de classification système.
SystemClassificationRuleProperties	Propriétés de la règle de classification système.

ClassificationAction

Énumération

Action de la règle de classification.

Valeur	Description
Keep
Delete

ClassificationRuleStatus

Énumération

État de la règle de classification système.

Valeur	Description
Enabled
Disabled

CustomClassificationRule

Object

Règle de classification personnalisée.

Nom	Type	Description
id	string	Identificateur de ressource.
kind	string: Custom	Type de règle de classification.
name	string	Nom de la ressource.
properties	CustomClassificationRuleProperties	Propriétés de la règle de classification personnalisée.

CustomClassificationRuleProperties

Object

Propriétés de la règle de classification personnalisée.

Nom	Type	Description
classificationAction	ClassificationAction	Action de la règle de classification.
classificationName	string	Nom de classification de la règle de classification personnalisée.
columnPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Modèles de colonne de règle de classification personnalisée.
createdAt	string (date-time)	Heure de création d’une règle de classification personnalisée.
dataPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Modèles de données de règle de classification personnalisée.
description	string	Description de la règle de classification personnalisée.
lastModifiedAt	string (date-time)	Heure de dernière modification de la règle de classification personnalisée.
minimumPercentageMatch	number (double)
ruleStatus	ClassificationRuleStatus	État de la règle de la règle de classification personnalisée.
version	integer (int32)	Version de la règle de classification personnalisée.

ErrorModel

Object

Modèle d’erreur.

Nom	Type	Description
code	string	Code d’erreur unique qui identifie l’erreur spécifique.
details	ErrorModel[]	Tableau d’objets ErrorModel imbriqués qui fournit des détails d’erreur supplémentaires.
message	string	Message d’erreur lisible par l’homme qui fournit plus de détails sur l’erreur.
target	string	Composant spécifique auquel l’erreur est associée.

ErrorResponseModel

Object

Modèle de réponse d’erreur.

Nom	Type	Description
error	ErrorModel	Modèle d’erreur.

RegexClassificationRulePattern

Object

Modèle de règle de classification regex.

Nom	Type	Description
kind	string: Regex	Propriétés du modèle de règle de classification.
pattern	string	Modèle de règle de classification regex.

SystemClassificationRule

Object

Règle de classification système.

Nom	Type	Description
id	string	Identificateur de ressource.
kind	string: System	Type de règle de classification.
name	string	Nom de la ressource.
properties	SystemClassificationRuleProperties	Propriétés de la règle de classification système.

SystemClassificationRuleProperties

Object

Propriétés de la règle de classification système.

Nom	Type	Description
classificationName	string	Nom de classification de la règle de classification système.
createdAt	string (date-time)	Heure de création de la règle de classification système.
description	string
lastModifiedAt	string (date-time)	Heure de dernière modification de la règle de classification système.
ruleStatus	ClassificationRuleStatus	État de la règle de classification système.
version	integer (int32)	Version de la règle de classification système.