Entity - Add Classifications By Unique Attribute

Referência

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 de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string
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 da solicitação

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

Respostas

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

Segurança

OAuth2Auth

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

Escopos

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

Exemplos

Entity_AddClassificationsByUniqueAttribute

Solicitação de exemplo

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 de exemplo

Código de status:: 204

Definições

Nome	Description
AtlasClassification	Uma instância de uma classificação; ele não tem uma identidade, esse objeto só existe 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

Uma instância de uma classificação; ele não tem uma identidade, esse objeto só existe quando associado a uma entidade.

Nome	Tipo	Description
attributes		Os atributos do struct.
entityGuid	string	O GUID da entidade.
entityStatus	EntityStatus	Status da entidade – pode estar ativo ou excluído. 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 de entidade.
typeName	string	O nome do tipo.
validityPeriods	TimeBoundary[]	Uma matriz de limites de tempo que indica períodos de validade.

AtlasErrorResponse

Uma resposta de erro do serviço

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

EntityStatus

Status – pode ser ativo ou excluído

Nome	Tipo	Description
ACTIVE	string	O status está ativo.
DELETED	string	O status é excluído.

TimeBoundary

Captura detalhes de limite de tempo

Nome	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.

Compartilhar via