Data Registry - Get Operation

Service:

Maps

API Version:

2023-06-01

Use para marcar o status do registro de dados ou a solicitação de substituição.
A Get Operation API é uma solicitação HTTP GET usada para obter o status de um registro de dados ou a solicitação de substituição é retornada no cabeçalho do registro ou substituir a resposta como o valor da Operation-Location chave. Enquanto estiver em andamento, uma resposta HTTP 200 OK será retornada com Retry-After o cabeçalho - seguido por um HTTP 200 OK sem cabeçalho adicional após a conclusão.

O ponto de extremidade de serviço do Registro de Dados é limitado no escopo para a região da sua conta de Azure Mapas e não está disponível para contas de Azure Mapas globais.

GET https://{geography}.atlas.microsoft.com/dataRegistries/operations/{operationId}?api-version=2023-06-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
geography	path	True	string	Esse parâmetro especifica onde a conta de Azure Mapas está localizada. Os valores válidos são nós (Leste dos EUA, Centro-Oeste dos EUA, Oeste dos EUA 2) e EU (Norte da Europa, Europa Ocidental).
operationId	path	True	string	A ID usada para consultar o status de uma solicitação de registro de dados. Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
api-version	query	True	string	O número de versão da API de Azure Mapas.

Respostas

Nome	Tipo	Description
200 OK	LongRunningOperationResult	O status da operação de execução prolongada. Headers Retry-After: integer
Other Status Codes	MapsErrorResponse	Erro inesperado. Headers x-ms-error-code: string

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

• Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de Microsoft Entra ID. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

• Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Essa é uma chave compartilhada provisionada ao criar um recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como master chaves para a conta para a qual são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor a servidor de Azure Mapas APIs REST em que essa chave pode ser armazenada com segurança.

Type: apiKey
In: header

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta do Mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Type: apiKey
In: header

Exemplos

Get the status of an operation that failed

Get the status of an operation that finished successfully

Get the status of an operation that is still running

Get the status of an operation that failed

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:

200

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Failed",
  "error": {
    "code": "InvalidData",
    "message": "The data is not a valid GeoJSON."
  }
}

Get the status of an operation that finished successfully

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:

200

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Completed"
}

Get the status of an operation that is still running

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:

200

Retry-After: 10

Response Body

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Running"
}

Definições

Nome	Description
LongRunningOperationResult	O modelo de resposta para uma operação de execução prolongada.
LongRunningOperationStatus	O status de uma operação de longa execução.
MapsErrorDetail	O detalhe do erro.
MapsErrorResponse	Resposta de erro comum para Azure Mapas APIs retornarem detalhes de erro para operações com falha.
MapsInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

LongRunningOperationResult

O modelo de resposta para uma operação de execução prolongada.

Nome	Tipo	Description
error	MapsErrorDetail	O detalhe do erro.
id	string	A operationId
status	LongRunningOperationStatus	O status de uma operação de longa execução.

LongRunningOperationStatus

O status de uma operação de longa execução.

Nome	Tipo	Description
Completed	string	A solicitação foi concluída com êxito.
Failed	string	A solicitação tem uma ou mais falhas.
Running	string	No momento, a solicitação está sendo processada.

MapsErrorDetail

O detalhe do erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	MapsErrorDetail[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	MapsInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo homem do erro.
target	string	O destino do erro.

MapsErrorResponse

Resposta de erro comum para Azure Mapas APIs retornarem detalhes de erro para operações com falha.

Nome	Tipo	Description
error	MapsErrorDetail	O detalhe do erro.

MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

Nome	Tipo	Description
code	string	O código de erro.
innererror	MapsInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.