Data Registry - Get Operation

  • Referência
Service:
Maps
API Version:
2023-06-01

Utilize para verificar o estado do registo de dados ou substituir o pedido.
A Get Operation API é um pedido HTTP GET utilizado para obter o estado de um registo de dados ou o pedido de substituição é devolvido no cabeçalho do registo ou substituir a resposta como o valor da Operation-Location chave. Enquanto estiver em curso, será devolvida uma resposta HTTP 200 OK com Retry-After o cabeçalho , seguido de um HTTP 200 OK sem cabeçalho adicional uma vez concluído.

O ponto final do serviço de registo de dados está limitado no âmbito da região da sua conta Azure Maps e não está disponível para contas de Azure Maps globais.

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

Parâmetros do URI

Name Em Necessário Tipo Description
geography
 path True

string

Este parâmetro especifica onde está localizada a Conta Azure Maps. Os valores válidos são nós (E.U.A. Leste, E.U.A. Centro-Oeste, E.U.A. Oeste 2) e eu (Europa do Norte, Europa Ocidental).
operationId
 path True

string

O ID utilizado para consultar o estado de um pedido de registo 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 da versão da API Azure Maps.

Respostas

Name Tipo Description
200 OK

LongRunningOperationResult

O estado da operação de execução prolongada.

Headers

Retry-After: integer
Other Status Codes

MapsErrorResponse

Ocorreu um erro inesperado.

Headers

x-ms-error-code: string

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

  • Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

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

Scopes

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

subscription-key

Esta é uma chave partilhada que é aprovisionada ao criar um recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST Azure Maps onde esta chave pode ser armazenada de forma segura.

Type: apiKey
In: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de 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

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

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

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

Name Description
LongRunningOperationResult

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

O estado de uma operação de execução prolongada.
MapsErrorDetail

O detalhe do erro.
MapsErrorResponse

Resposta de erro comum para Azure Maps APIs para devolver detalhes de erro para operações falhadas.
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.

Name Tipo Description
error

MapsErrorDetail

O detalhe do erro.
id

string

O operationId
status

LongRunningOperationStatus

O estado de uma operação de execução prolongada.

LongRunningOperationStatus

O estado de uma operação de execução prolongada.

Name Tipo Description
Completed

string

O pedido foi concluído com êxito.
Failed

string

O pedido tem uma ou mais falhas.
Running

string

O pedido está atualmente a ser processado.

MapsErrorDetail

O detalhe do erro.

Name Tipo Description
code

string

Um dos conjuntos de códigos de erro definidos pelo servidor.
details

MapsErrorDetail[]

Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
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 por humanos do erro.
target

string

O destino do erro.

MapsErrorResponse

Resposta de erro comum para Azure Maps APIs para devolver detalhes de erro para operações falhadas.

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

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