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 |
|
|
id
|
path | True |
string minLength: 36maxLength: 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 |
A solicitação foi bem-sucedida. |
|
| 404 Not Found |
O servidor não pode encontrar o recurso solicitado. |
|
| Other Status Codes |
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 principal de serviço pode receber acesso via um papel embutido ou um papel personalizado composto por uma ou mais permissões para Azure Mapas APIs REST.\n\nPara implementar cenários, recomendamos visualizar conceitos autenticação. Em resumo, essa definição de segurança fornece uma solução para modelagem de aplicações(ões) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.\n\n#### Notas\n* Esta definição de segurança exige o uso do cabeçalho x-ms-client-id para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento Maps.\n* \nO Authorization URL é específico para a instância Azure nuvem pública. As nuvens soberanas possuem URLs de Autorização e configurações de Microsoft Entra ID únicas. \n* \nO controle de acesso baseado em função Azure é configurado a partir do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n* \nUso do Azure Mapas Web SDK permite a configuração de uma aplicação baseada em configuração para múltiplos casos de uso.\n* Para mais informações sobre plataforma de identidade da Microsoft, veja plataforma de identidade da Microsoft visão geral.
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
Esta é uma chave compartilhada que é provisionada quando você Criar uma conta Azure Mapas no portal Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.\n\n 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 são emitidas.\n\n Para aplicações publicamente expostas, nossa recomendação é usar a abordagem confidenciais de aplicativos clientes para acessar APIs REST Azure Mapas e assim sua chave possa 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 List SAS no recurso Azure Mapas através do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n\n Com este token, qualquer aplicativo está autorizado a acessar com Azure controles de acesso baseados em funções e controle detalhado da expiração, taxa e região(s) de uso do token específico. Em outras palavras, o Token SAS pode ser usado para permitir que aplicações controlem o acesso de forma mais segura do que a chave compartilhada.\n\n Para aplicações publicamente expostas, nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta Map para limitar abusos 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 {endpoint}/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 |
|---|---|
|
Common |
O detalhe do erro. |
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Maps |
O detalhe do erro. |
|
Maps |
Resposta comum de erro para APIs do Azure Mapas devolver detalhes de erro em operações falhadas. |
|
Maps |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
Route |
Este objeto é retornado a partir de uma solicitação de Operação Obter bem-sucedida. |
|
Route |
Tipo de operação assíncrona |
|
Route |
O resultado da operação assíncrona |
|
Status |
Status atual da operação assíncrona. |
CommonErrorDetail
O detalhe do erro.
| Nome | Tipo | Description |
|---|---|---|
| additionalInfo |
As informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
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 |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
|
| innererror |
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 |
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 |
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 |
O detalhe do erro. |
|
| id |
string |
Identificador único para a operação assíncrona. |
| kind |
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 |
O resultado da operação assíncrona |
|
| status |
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. |