Route - Get Route Operations Status
Obtén el estado de una operación asíncrona por su ID de operación.
GET {endpoint}/route/operations/{id}?api-version=2025-01-01
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
El nombre de host del servicio 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}$ |
El sistema generó un identificador único para la operación asincrónica una vez enviado. |
|
api-version
|
query | True |
string minLength: 1 |
Versión de API que se usará para esta operación. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
La solicitud se ha realizado correctamente. |
|
| 404 Not Found |
El servidor no encuentra el recurso solicitado. |
|
| Other Status Codes |
Una respuesta de error inesperada. |
Seguridad
AadToken
Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.
Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.
Note
- Esta definición de seguridad requiere el uso del encabezado
x-ms-client-idpara indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps. - El
Authorization URLes específico de la instancia de nube pública de Azure. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. - El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
- El uso de SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
- Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Se trata de una clave compartida que se aprovisiona al Creación de una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.
Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.
Para las aplicaciones expuestas públicamente, nuestra recomendación es usar las aplicaciones cliente confidenciales enfoque acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.
Tipo:
apiKey
En:
header
SAS Token
Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.
Tipo:
apiKey
En:
header
Ejemplos
Retrieve the async matrix operation status
Solicitud de ejemplo
GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01
Respuesta de muestra
{
"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."
}
}
Definiciones
| Nombre | Description |
|---|---|
|
Common |
Detalle del error. |
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Maps |
Detalle del error. |
|
Maps |
Respuesta común a errores para que las APIs de Azure Maps devolvan detalles de error por operaciones fallidas. |
|
Maps |
Objeto que contiene información más específica que el objeto actual sobre el error. |
|
Route |
Este objeto se devuelve tras una solicitud de Get Operation exitosa. |
|
Route |
Tipo de operación asincrónica |
|
Route |
El resultado de una operación asíncrona |
|
Status |
Estado actual de la operación asincrónica. |
CommonErrorDetail
Detalle del error.
| Nombre | Tipo | Description |
|---|---|---|
| additionalInfo |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
Detalles del error. |
|
| message |
string |
El mensaje de error. |
| target |
string |
Destino del error. |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
| Nombre | Tipo | Description |
|---|---|---|
| info |
object |
Información adicional. |
| type |
string |
Tipo de información adicional. |
MapsErrorDetail
Detalle del error.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Uno de un conjunto definido por el servidor de códigos de error. |
| details |
Matriz de detalles sobre errores específicos que llevaron a este error notificado. |
|
| innererror |
Objeto que contiene información más específica que el objeto actual sobre el error. |
|
| message |
string |
Representación legible del error. |
| target |
string |
Destino del error. |
MapsErrorResponse
Respuesta común a errores para que las APIs de Azure Maps devolvan detalles de error por operaciones fallidas.
| Nombre | Tipo | Description |
|---|---|---|
| error |
Detalle del error. |
MapsInnerError
Objeto que contiene información más específica que el objeto actual sobre el error.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Código de error. |
| innererror |
Objeto que contiene información más específica que el objeto actual sobre el error. |
RouteOperation
Este objeto se devuelve tras una solicitud de Get Operation exitosa.
| Nombre | Tipo | Description |
|---|---|---|
| createdAt |
string (date-time) |
Marca de tiempo en la que se creó la operación. |
| error |
Detalle del error. |
|
| id |
string |
Identificador único para la operación asíncrona. |
| kind |
Tipo de operación asincrónica |
|
| lastActionAt |
string (date-time) |
Marca de tiempo cuando se actualizó el estado de la operación. |
| result |
El resultado de una operación asíncrona |
|
| status |
Estado actual de la operación asincrónica. |
RouteOperationKindEnum
Tipo de operación asincrónica
| Valor | Description |
|---|---|
| RouteMatrix |
Trabajo asincrónico de matriz de rutas. |
RouteOperationResult
El resultado de una operación asíncrona
| Nombre | Tipo | Description |
|---|---|---|
| resultUrl |
string (uri) |
URL para obtener el resultado de la operación asíncrona |
StatusEnum
Estado actual de la operación asincrónica.
| Valor | Description |
|---|---|
| NotStarted |
La operación aún no ha comenzado. |
| Running |
La operación está en marcha. |
| Completed |
La operación se ha completado correctamente. |
| Failed |
La operación ha fallado. |