Route - Get Route Operations Status
Obtenha o estado de uma operação assíncrona pelo seu ID de operação.
GET {endpoint}/route/operations/{id}?api-version=2025-01-01
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
O nome de host do serviço Azure Maps. Usa |
|
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 minLength: 1 |
A versão da API a utilizar para esta operação. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
O pedido foi bem-sucedido. |
|
| 404 Not Found |
O servidor não consegue 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 controlo Azure baseado em funções, pode ser usado para controlar o acesso a APIs REST Azure Maps. Os controlos de acesso baseados em papéis do Azure são usados para designar o acesso a uma ou mais contas ou subrecursos de recursos 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.
Note
- 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 clouds soberanas têm URLs de Autorização e configurações de Microsoft Entra ID únicas. - 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 |
subscription-key
Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.
Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.
Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que 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 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 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
{
"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
| Name | Description |
|---|---|
|
Common |
O detalhe do erro. |
|
Error |
O erro de gerenciamento de recursos informações adicionais. |
|
Maps |
O detalhe do erro. |
|
Maps |
Resposta comum ao erro para APIs do Azure Maps 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 é devolvido a partir de um pedido Get Operation bem-sucedido. |
|
Route |
Tipo de operação assíncrona |
|
Route |
O resultado de uma operação assíncrona |
|
Status |
Estado atual da operação assíncrona. |
CommonErrorDetail
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. |
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. |
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 comum ao erro para APIs do Azure Maps devolver detalhes de erro em operações falhadas.
| 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. |
RouteOperation
Este objeto é devolvido a partir de um pedido Get Operation bem-sucedido.
| Name | Tipo | Description |
|---|---|---|
| createdAt |
string (date-time) |
Carimbo temporal em que a operação foi criada. |
| 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 temporal em que o estado da operação foi atualizado. |
| result |
O resultado de uma operação assíncrona |
|
| status |
Estado atual da operação assíncrona. |
RouteOperationKindEnum
Tipo de operação assíncrona
| Valor | Description |
|---|---|
| RouteMatrix |
Trabalho assíncrono de matriz de rota. |
RouteOperationResult
O resultado de uma operação assíncrona
| Name | Tipo | Description |
|---|---|---|
| resultUrl |
string (uri) |
URL para obter o resultado da operação assíncrona |
StatusEnum
Estado atual da operação assíncrona.
| Valor | Description |
|---|---|
| NotStarted |
A operação ainda não começou. |
| Running |
A operação está a decorrer. |
| Completed |
A operação foi concluída com êxito. |
| Failed |
A operação falhou. |