Entity - Add Classifications By Unique Attribute

Tjänst:

Purview

API-version:

2023-09-01

Lägg till klassificering till den entitet som identifieras av dess typ och unika attribut.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)
typeName	path	True	string	Namnet på typen.
attr:qualifiedName	query		string	Det kvalificerade namnet på entiteten. (Det här är bara ett exempel. qualifiedName kan ändras till andra unika attribut)

Begärandetext

Name	Typ	Description
body	AtlasClassification[]	En klassificeringsmatris som ska läggas till.

Svar

Name	Typ	Description
204 No Content		Det finns inget innehåll att skicka för den här begäran, men rubrikerna kan vara användbara.
Other Status Codes	AtlasErrorResponse	Ett oväntat felsvar.

Säkerhet

OAuth2Auth

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

Omfattningar

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

Exempel

Entity_AddClassificationsByUniqueAttribute

Exempelbegäran

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

Exempelsvar

Statuskod:

204

Definitioner

Name	Description
AtlasClassification	En instans av en klassificering; Det har ingen identitet. Det här objektet finns bara när det är associerat med en entitet.
AtlasErrorResponse	Ett felsvar från tjänsten
EntityStatus	Status – kan vara aktiv eller borttagen
TimeBoundary	Samlar in information om tidsgräns

AtlasClassification

Objekt

En instans av en klassificering; Det har ingen identitet. Det här objektet finns bara när det är associerat med en entitet.

Name	Typ	Description
attributes		Attributen för structen.
entityGuid	string	GUID för entiteten.
entityStatus	EntityStatus	Status för entiteten – kan vara aktiv eller borttagen. Borttagna entiteter tas inte bort.
lastModifiedTS	string	ETag för samtidighetskontroll.
removePropagationsOnEntityDelete	boolean	Avgör om spridning kommer att tas bort vid borttagning av entitet.
typeName	string	Namnet på typen.
validityPeriods	TimeBoundary[]	En matris med tidsgränser som anger giltighetsperioder.

AtlasErrorResponse

Objekt

Ett felsvar från tjänsten

Name	Typ	Description
errorCode	string	Felkoden.
errorMessage	string	Felmeddelandet.
requestId	string (uuid)	Begärande-ID:t.

EntityStatus

Uppräkning

Status – kan vara aktiv eller borttagen

Värde	Description
ACTIVE	Statusen är aktiv.
DELETED	Statusen tas bort.

TimeBoundary

Objekt

Samlar in information om tidsgräns

Name	Typ	Description
endTime	string	Slutet av tidsgränsen.
startTime	string	Start av tidsgränsen.
timeZone	string	Tidszonen för tidsgränsen.