Entity - Add Classifications By Unique Attribute

Référence

Service:: Purview

Version d'API:: 2023-09-01

Ajoutez une classification à l’entité identifiée par son type et ses attributs uniques.

POST {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications

Avec des paramètres facultatifs:

POST {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications?attr:qualifiedName={attr:qualifiedName}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string
typeName	path	True	string	Nom du type.
attr:qualifiedName	query		string	Nom qualifié de l’entité. (Il ne s’agit que d’un exemple. qualifiedName peut être remplacé par d’autres attributs uniques)

Corps de la demande

Nom	Type	Description
body	AtlasClassification[]	Tableau de classification à ajouter.

Réponses

Nom	Type	Description
204 No Content		Il n’y a pas de contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles.
Other Status Codes	AtlasErrorResponse	Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

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

Étendues

Nom	Description
https://purview.azure.net/.default

Exemples

Entity_AddClassificationsByUniqueAttribute

Exemple de requête

HTTP

POST {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/azure_storage_account/classifications?attr:qualifiedName=https://exampleaccount.core.windows.net

[
  {
    "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER"
  },
  {
    "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER"
  }
]

Exemple de réponse

Code d’état:: 204

Définitions

Nom	Description
AtlasClassification	Un instance d’une classification ; il n’a pas d’identité, cet objet existe uniquement lorsqu’il est associé à une entité.
AtlasErrorResponse	Réponse d’erreur du service
EntityStatus	État : peut être actif ou supprimé
TimeBoundary	Capture les détails de la limite de temps

AtlasClassification

Un instance d’une classification ; il n’a pas d’identité, cet objet existe uniquement lorsqu’il est associé à une entité.

Nom	Type	Description
attributes		Attributs du struct.
entityGuid	string	GUID de l’entité.
entityStatus	EntityStatus	État de l’entité : peut être actif ou supprimé. Les entités supprimées ne sont pas supprimées.
lastModifiedTS	string	ETag pour le contrôle d’accès concurrentiel.
removePropagationsOnEntityDelete	boolean	Détermine si les propagations seront supprimées lors de la suppression d’entité.
typeName	string	Nom du type.
validityPeriods	TimeBoundary[]	Tableau de limites de temps indiquant des périodes de validité.

AtlasErrorResponse

Réponse d’erreur du service

Nom	Type	Description
errorCode	string	Code d'erreur.
errorMessage	string	Message d’erreur.
requestId	string	ID de demande.

EntityStatus

État : peut être actif ou supprimé

Nom	Type	Description
ACTIVE	string	Le status est actif.
DELETED	string	Le status est supprimé.

TimeBoundary

Capture les détails de la limite de temps

Nom	Type	Description
endTime	string	Fin de la limite de temps.
startTime	string	Début de la limite de temps.
timeZone	string	Fuseau horaire de la limite de temps.

Partager via