Entity - Add Classifications By Unique Attribute

Serviço:

Purview

Versão da API:

2023-09-01

Adicione classificação à entidade identificada por seu tipo e atributos exclusivos.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)
typeName	path	True	string	O nome do tipo.
attr:qualifiedName	query		string	O nome qualificado da entidade. (Este é apenas um exemplo. qualifiedName pode ser alterado para outros atributos exclusivos)

Corpo do Pedido

Name	Tipo	Description
body	AtlasClassification[]	Uma matriz de classificação a ser adicionada.

Respostas

Name	Tipo	Description
204 No Content		Não há conteúdo para enviar para esta solicitação, mas os cabeçalhos podem ser úteis.
Other Status Codes	AtlasErrorResponse	Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

Exemplos

Entity_AddClassificationsByUniqueAttribute

Pedido de amostra

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

Resposta da amostra

Código de estado:

204

Definições

Name	Description
AtlasClassification	Um exemplo de uma classificação; Ele não tem uma identidade, este objeto existe apenas quando associado a uma entidade.
AtlasErrorResponse	Uma resposta de erro do serviço
EntityStatus	Status - pode ser ativo ou excluído
TimeBoundary	Captura detalhes de limite de tempo

AtlasClassification

Object

Um exemplo de uma classificação; Ele não tem uma identidade, este objeto existe apenas quando associado a uma entidade.

Name	Tipo	Description
attributes		Os atributos do struct.
entityGuid	string	O GUID da entidade.
entityStatus	EntityStatus	Status da entidade - pode ser ativo ou excluído. As entidades excluídas não são removidas.
lastModifiedTS	string	ETag para controle de simultaneidade.
removePropagationsOnEntityDelete	boolean	Determina se as propagações serão removidas na exclusão da entidade.
typeName	string	O nome do tipo.
validityPeriods	TimeBoundary[]	Uma matriz de limites de tempo indicando períodos de validade.

AtlasErrorResponse

Object

Uma resposta de erro do serviço

Name	Tipo	Description
errorCode	string	O código de erro.
errorMessage	string	A mensagem de erro.
requestId	string (uuid)	O ID da solicitação.

EntityStatus

Enumeração

Status - pode ser ativo ou excluído

Valor	Description
ACTIVE	O status está ativo.
DELETED	O status é excluído.

TimeBoundary

Object

Captura detalhes de limite de tempo

Name	Tipo	Description
endTime	string	O fim do limite de tempo.
startTime	string	O início do limite de tempo.
timeZone	string	O fuso horário do limite de tempo.