Route - Get Route Operations Result
Obtenha o resultado de uma operação assíncrona pelo seu ID de operação.
GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2025-01-01
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
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 após o envio. |
|
api-version
|
query | True |
string |
Número da versão da API do Azure Maps. |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indica a conta destinada a ser usada com o modelo de segurança Microsoft Entra ID. Essa ID exclusiva para a conta do Azure Maps pode ser obtida na API de Conta do plano de gerenciamento do Azure Maps. Para obter mais informações sobre como usar a segurança do Microsoft Entra ID no Azure Maps, consulte Gerenciar autenticação no Azure Maps. |
|
| Accept-Language |
string |
Idioma em que os resultados de roteamento devem ser retornados. Para obter mais informações, consulte Suporte de localização no Azure Maps. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK | RouteOperationResponse: |
OK |
| 404 Not Found |
O resultado do recurso da operação não foi encontrado. Cabeçalhos x-ms-error-code: string |
|
| Other Status Codes |
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-idpara 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
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
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
Tipo:
apiKey
Em:
header
Exemplos
Retrieve the async matrix result
Pedido de amostra
GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01
Resposta da amostra
{
"kind": "RouteMatrix",
"type": "Feature",
"geometry": null,
"properties": {
"summary": {
"totalCount": 4,
"successfulCount": 2
},
"matrix": [
{
"statusCode": 200,
"originIndex": 0,
"destinationIndex": 0,
"departureAt": "2022-12-19T16:39:57+01:00",
"arrivalAt": "2022-12-20T00:21:14+01:00",
"distanceInMeters": 573064,
"durationInSeconds": 27677,
"durationTrafficInSeconds": 27677
},
{
"statusCode": 400,
"originIndex": 0,
"destinationIndex": 1,
"error": {
"code": "OUT_OF_REGION",
"message": "Input coordinates out of region"
}
},
{
"statusCode": 200,
"originIndex": 1,
"destinationIndex": 0,
"departureAt": "2022-12-19T16:39:57+01:00",
"arrivalAt": "2022-12-19T22:19:10+01:00",
"distanceInMeters": 452488,
"durationInSeconds": 20353,
"durationTrafficInSeconds": 20353
},
{
"statusCode": 400,
"originIndex": 1,
"destinationIndex": 1,
"error": {
"code": "OUT_OF_REGION",
"message": "Input coordinates out of region"
}
}
]
}
}
{
"error": {
"code": "NotFound",
"message": "Not Found: the requested resource could not be found."
}
}
Definições
| Name | Description |
|---|---|
|
Error |
O erro de gerenciamento de recursos informações adicionais. |
|
Error |
O detalhe do erro. |
|
Features |
Especifica o tipo de |
|
Maps |
O detalhe do erro. |
|
Maps |
Resposta de erro comum para APIs do Azure Maps para retornar detalhes de erro para operações com falha. |
|
Maps |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
Route |
Especifica as instruções de condução e as propriedades adicionais para cada ponto de manobra na perna do percurso. |
|
Route |
Propriedades da matriz de rota. |
|
Route |
Resultado do item Route Matrix |
|
Route |
Resumo da solicitação de matriz de rota |
|
Route |
Tipo de 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 |
O erro informações adicionais. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
FeaturesItemTypeEnum
Especifica o tipo de GeoJSON. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.
| Valor | Description |
|---|---|
| Feature |
Especifica o tipo de objeto |
MapsErrorDetail
O detalhe do erro.
| Name | Tipo | Description |
|---|---|---|
| code |
string |
Um de um conjunto de códigos de erro definido pelo servidor. |
| 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 por humanos do erro. |
| target |
string |
O alvo do erro. |
MapsErrorResponse
Resposta de erro comum para APIs do Azure Maps para retornar detalhes de erro para operações com falha.
| Name | 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.
| Name | 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. |
RouteMatrixAsyncResponse
Especifica as instruções de condução e as propriedades adicionais para cada ponto de manobra na perna do percurso.
| Name | Tipo | Description |
|---|---|---|
| geometry |
object |
O objeto geometry é null |
| kind |
string:
Route |
Tipo de operação assíncrona |
| properties |
Propriedades da matriz de rota. |
|
| type |
Especifica o tipo de |
RouteMatrixFeatureProperties
Propriedades da matriz de rota.
| Name | Tipo | Description |
|---|---|---|
| matrix |
A matriz de resultados da rota. |
|
| summary |
Resumo da solicitação de matriz de rota |
RouteMatrixItemResult
Resultado do item Route Matrix
| Name | Tipo | Description |
|---|---|---|
| arrivalAt |
string (date-time) |
A hora de chegada estimada, que leva em conta as condições de tráfego, é formatada como um valor de |
| departureAt |
string (date-time) |
O tempo de partida estimado, que leva em conta as condições de tráfego, é formatado como um valor de |
| destinationIndex |
integer (int32) |
Índice do ponto de destino |
| distanceInMeters |
number (double) |
Comprimento em metros propriedade |
| durationInSeconds |
integer (int64) |
Tempo de viagem estimado em segundos que não inclui atrasos na rota devido às condições de tráfego. |
| durationTrafficInSeconds |
integer (int64) |
O tempo que demora, em segundos, a percorrer um |
| error |
O detalhe do erro. |
|
| originIndex |
integer (int32) |
Índice do ponto de origem |
| statusCode |
integer (int32) |
O código de status HTTP da célula atual. |
RouteMatrixSummary
Resumo da solicitação de matriz de rota
| Name | Tipo | Description |
|---|---|---|
| successfulCount |
integer (int32) |
Número de rotas bem-sucedidas dentro desta matriz. |
| totalCount |
integer (int32) |
Número total de rotas dentro desta matriz. |
RouteOperationKindEnum
Tipo de operação assíncrona
| Valor | Description |
|---|---|
| RouteMatrix |
Trabalho assíncrono de matriz de rota. |