Entity - Add Classifications By Unique Attribute

Servicio:

Purview

Versión de la API:

2023-09-01

Agregue clasificación a la entidad identificada por su tipo y atributos únicos.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string
typeName	path	True	string	Nombre del tipo.
attr:qualifiedName	query		string	Nombre completo de la entidad. (Este es solo un ejemplo. qualifiedName se puede cambiar a otros atributos únicos).

Cuerpo de la solicitud

Nombre	Tipo	Description
body	AtlasClassification[]	Matriz de clasificación que se va a agregar.

Respuestas

Nombre	Tipo	Description
204 No Content		No hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.
Other Status Codes	AtlasErrorResponse	Respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

Entity_AddClassificationsByUniqueAttribute

Solicitud de ejemplo

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

Respuesta de muestra

status code:

204

Definiciones

Nombre	Description
AtlasClassification	Instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.
AtlasErrorResponse	Respuesta de error del servicio
EntityStatus	Estado: puede estar activo o eliminado.
TimeBoundary	Captura los detalles del límite de tiempo

AtlasClassification

Instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.

Nombre	Tipo	Description
attributes		Atributos de la estructura.
entityGuid	string	GUID de la entidad.
entityStatus	EntityStatus	Estado de la entidad: puede estar activo o eliminado. No se quitan las entidades eliminadas.
lastModifiedTS	string	ETag para el control de simultaneidad.
removePropagationsOnEntityDelete	boolean	Determina si se quitarán las propagaciones en la eliminación de entidades.
typeName	string	Nombre del tipo.
validityPeriods	TimeBoundary[]	Matriz de límites de tiempo que indica períodos de validez.

AtlasErrorResponse

Respuesta de error del servicio

Nombre	Tipo	Description
errorCode	string	Código de error.
errorMessage	string	El mensaje de error.
requestId	string	El identificador de solicitud.

EntityStatus

Estado: puede estar activo o eliminado.

Nombre	Tipo	Description
ACTIVE	string	El estado está activo.
DELETED	string	El estado se elimina.

TimeBoundary

Captura los detalles del límite de tiempo

Nombre	Tipo	Description
endTime	string	Fin del límite de tiempo.
startTime	string	Inicio del límite de tiempo.
timeZone	string	Zona horaria del límite de tiempo.