Route - Get Route Operations Status

Obtenha o status de uma operação assíncrona pelo seu ID de operação.

GET {endpoint}/route/operations/{id}?api-version=2025-01-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string (uri)

O nome de host do serviço Azure Mapas. Use https://atlas.microsoft.com para a Azure nuvem pública. Para direcionar uma geografia Azure Mapas específica ou uma nuvem soberana, veja Azure Mapas escopo geográfico.

id
path True

string

minLength: 36
maxLength: 36
pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

Identificador exclusivo gerado pelo sistema para a operação assíncrona depois que ela foi enviada.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

RouteOperation

A solicitação foi bem-sucedida.

404 Not Found

MapsErrorResponse

O servidor não pode encontrar o recurso solicitado.

Other Status Codes

MapsErrorResponse

Uma resposta de erro inesperada.

Segurança

AadToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com o controle de acesso baseado em funções Azure , pode ser usado para controlar o acesso às APIs REST Azure Mapas. Controles de acesso baseados em função do Azure são usados para designar acesso a uma ou mais contas ou subrecursos de recursos do Azure Mapas. 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 APIs REST do Azure Mapas.

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 controlar o acesso em APIs e escopos específicos.

Note

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.
  • O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas possuem URLs de Autorização e configurações de Microsoft Entra ID únicas.
  • O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
  • O uso do SDK da Web do do 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 a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

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

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o aplicativos cliente confidenciais abordagem para acessar AS APIs REST do Azure Mapas para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

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

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) 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 forma mais protegida do que a chave compartilhada.

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

Tipo: apiKey
Em: header

Exemplos

Retrieve the async matrix operation status

Solicitação de exemplo

GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01

Resposta de exemplo

{
  "createdAt": "2023-01-01T00:00:00Z",
  "kind": "RouteMatrix",
  "lastActionAt": "2023-01-01T00:05:00Z",
  "result": {
    "resultUrl": "https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01"
  },
  "status": "Completed"
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Definições

Nome Description
CommonErrorDetail

O detalhe do erro.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

MapsErrorDetail

O detalhe do erro.

MapsErrorResponse

Resposta comum de erro para APIs do Azure Mapas devolver detalhes de erro em operações falhadas.

MapsInnerError

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

RouteOperation

Este objeto é retornado a partir de uma solicitação de Operação Obter bem-sucedida.

RouteOperationKindEnum

Tipo de operação assíncrona

RouteOperationResult

O resultado da operação assíncrona

StatusEnum

Status atual da operação assíncrona.

CommonErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

CommonErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

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 ser humano do erro.

target

string

O destino do erro.

MapsErrorResponse

Resposta comum de erro para APIs do Azure Mapas devolver detalhes de erro em operações falhadas.

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.

RouteOperation

Este objeto é retornado a partir de uma solicitação de Operação Obter bem-sucedida.

Nome Tipo Description
createdAt

string (date-time)

Carimbo de data e hora da criação da operação.

error

CommonErrorDetail

O detalhe do erro.

id

string

Identificador único para a operação assíncrona.

kind

RouteOperationKindEnum

Tipo de operação assíncrona

lastActionAt

string (date-time)

Carimbo de data e hora em que o status da operação foi atualizado.

result

RouteOperationResult

O resultado da operação assíncrona

status

StatusEnum

Status atual da operação assíncrona.

RouteOperationKindEnum

Tipo de operação assíncrona

Valor Description
RouteMatrix

Trabalho assíncrono da matriz de rotas.

RouteOperationResult

O resultado da operação assíncrona

Nome Tipo Description
resultUrl

string (uri)

URL para obter o resultado da operação assíncrona

StatusEnum

Status atual da operação assíncrona.

Valor Description
NotStarted

A operação ainda não começou.

Running

A operação está em andamento.

Completed

A operação foi concluída com êxito.

Failed

A operação falhou.