Partilhar via


Route - Get Route Operations Status

Obtenha o status de uma operação assíncrona por sua ID de operação.

GET https://atlas.microsoft.com/route/operations/{id}?api-version=2025-01-01

Parâmetros do URI

Name Em Necessário Tipo Description
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 após o envio.

api-version
query True

string

Número da versão da API do Azure Maps.

Respostas

Name Tipo Description
200 OK

RouteOperation

OK

404 Not Found

ErrorResponse

O recurso da operação não foi encontrado.

Cabeçalhos

x-ms-error-code: string

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Cabeçalhos

x-ms-error-code: string

Segurança

AADToken

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

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

Observação

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps.
  • 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 ID do Microsoft Entra.
  • O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
  • O uso do SDK da Web do Azure Maps 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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

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

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras para a conta para a qual foram emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor para servidor das APIs REST do Azure Maps onde essa chave pode ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

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

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(õ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 forma mais segura 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 do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Retrieve the async matrix operation status

Pedido de amostra

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

Resposta da amostra

{
  "kind": "RouteMatrix",
  "status": "Completed",
  "createdAt": "2023-01-01T00:00:00Z",
  "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"
  }
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Definições

Name Description
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

Result

O resultado da operação assíncrona

RouteOperation

Este objeto é retornado de uma solicitação Get Operation bem-sucedida.

RouteOperationKindEnum

Tipo de operação assíncrona

StatusEnum

Status atual da operação assíncrona.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

Result

O resultado da operação assíncrona

Name Tipo Description
resultUrl

string (uri)

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

RouteOperation

Este objeto é retornado de uma solicitação Get Operation bem-sucedida.

Name Tipo Description
createdAt

string (date-time)

Carimbo de data/hora quando a operação foi criada.

error

ErrorDetail

O detalhe do erro.

id

string

Identificador exclusivo para a operação assíncrona.

kind

RouteOperationKindEnum

Tipo de operação assíncrona

lastActionAt

string (date-time)

Carimbo de data/hora quando o status da operação foi atualizado.

result

Result

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 de matriz de rota.

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 execução.

Completed

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

Failed

A operação falhou.