Entity - Add Classifications By Unique Attribute

Service:

Purview

API-versie:

2023-09-01

Voeg classificatie toe aan de entiteit die is geïdentificeerd door het type en unieke kenmerken.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)
typeName	path	True	string	De naam van het type.
attr:qualifiedName	query		string	De gekwalificeerde naam van de entiteit. (Dit is slechts een voorbeeld. qualifiedName kan worden gewijzigd in andere unieke kenmerken)

Aanvraagbody

Name	Type	Description
body	AtlasClassification[]	Een matrix van classificatie die moet worden toegevoegd.

Antwoorden

Name	Type	Description
204 No Content		Er is geen inhoud die voor deze aanvraag kan worden verzonden, maar de headers kunnen nuttig zijn.
Other Status Codes	AtlasErrorResponse	Een onverwachte foutreactie.

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeelden

Entity_AddClassificationsByUniqueAttribute

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

204

Definities

Name	Description
AtlasClassification	Een instantie van een classificatie; het heeft geen identiteit, dit object bestaat alleen als het is gekoppeld aan een entiteit.
AtlasErrorResponse	Een foutreactie van de service
EntityStatus	Status : kan actief of verwijderd zijn
TimeBoundary	Legt details over de tijdgrens vast

AtlasClassification

Object

Een instantie van een classificatie; het heeft geen identiteit, dit object bestaat alleen als het is gekoppeld aan een entiteit.

Name	Type	Description
attributes		De kenmerken van de struct.
entityGuid	string	De GUID van de entiteit.
entityStatus	EntityStatus	Status van de entiteit: kan actief of verwijderd zijn. Verwijderde entiteiten worden niet verwijderd.
lastModifiedTS	string	ETag voor gelijktijdigheidsbeheer.
removePropagationsOnEntityDelete	boolean	Bepaalt of doorgiften worden verwijderd bij het verwijderen van entiteiten.
typeName	string	De naam van het type.
validityPeriods	TimeBoundary[]	Een matrix met tijdsgrenzen die geldigheidsperioden aangeven.

AtlasErrorResponse

Object

Een foutreactie van de service

Name	Type	Description
errorCode	string	De foutcode.
errorMessage	string	Het foutbericht.
requestId	string (uuid)	De aanvraag-id.

EntityStatus

Inventarisatie

Status : kan actief of verwijderd zijn

Waarde	Description
ACTIVE	De status is actief.
DELETED	De status wordt verwijderd.

TimeBoundary

Object

Legt details over de tijdgrens vast

Name	Type	Description
endTime	string	Het einde van de tijdsgrens.
startTime	string	Het begin van de tijdsgrens.
timeZone	string	De tijdzone van de tijdsgrens.