Entity - Add Classifications By Unique Attribute

Dienst:

Purview

API-Version:

2023-09-01

Fügen Sie der Entität, die durch ihren Typ und eindeutige Attribute identifiziert wird, eine Klassifizierung hinzu.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)
typeName	path	True	string	Der Name des Typs.
attr:qualifiedName	query		string	Der qualifizierte Name der Entität. (Dies ist nur ein Beispiel. qualifiedName kann in andere eindeutige Attribute geändert werden)

Anforderungstext

Name	Typ	Beschreibung
body	AtlasClassification[]	Ein Array der hinzuzufügenden Klassifizierung.

Antworten

Name	Typ	Beschreibung
204 No Content		Es gibt keinen Inhalt, der für diese Anforderung gesendet werden soll, aber die Header können nützlich sein.
Other Status Codes	AtlasErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://purview.azure.net/.default

Beispiele

Entity_AddClassificationsByUniqueAttribute

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

204

Definitionen

Name	Beschreibung
AtlasClassification	Eine Instanz einer Klassifizierung; es hat keine Identität, dieses Objekt ist nur vorhanden, wenn es einer Entität zugeordnet ist.
AtlasErrorResponse	Eine Fehlerantwort des Diensts
EntityStatus	Status – kann aktiv oder gelöscht werden
TimeBoundary	Erfasst Zeitbegrenzungsdetails

AtlasClassification

Objekt

Eine Instanz einer Klassifizierung; es hat keine Identität, dieses Objekt ist nur vorhanden, wenn es einer Entität zugeordnet ist.

Name	Typ	Beschreibung
attributes		Die Attribute der Struktur.
entityGuid	string	Die GUID der Entität.
entityStatus	EntityStatus	Status der Entität – kann aktiv oder gelöscht werden. Gelöschte Entitäten werden nicht entfernt.
lastModifiedTS	string	ETag für Parallelitätssteuerelement.
removePropagationsOnEntityDelete	boolean	Bestimmt, ob Verteilungen beim Löschen der Entität entfernt werden.
typeName	string	Der Name des Typs.
validityPeriods	TimeBoundary[]	Ein Array von Zeitgrenzen, das gültigkeitsperioden angibt.

AtlasErrorResponse

Objekt

Eine Fehlerantwort des Diensts

Name	Typ	Beschreibung
errorCode	string	Der Fehlercode.
errorMessage	string	Die Fehlermeldung.
requestId	string (uuid)	Die Anforderungs-ID.

EntityStatus

Enumeration

Status – kann aktiv oder gelöscht werden

Wert	Beschreibung
ACTIVE	Der Status ist aktiv.
DELETED	Der Status wird gelöscht.

TimeBoundary

Objekt

Erfasst Zeitbegrenzungsdetails

Name	Typ	Beschreibung
endTime	string	Das Ende der Zeitgrenze.
startTime	string	Der Anfang der Zeitgrenze.
timeZone	string	Die Zeitzone der Zeitgrenze.