Route - Get Route Operations Result
Obtenga el resultado de una operación asincrónica por su identificador de operación.
GET {endpoint}/route/operations/{id}/result?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. |
Encabezado de la solicitud
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indica la cuenta destinada a usarse con el modelo de seguridad Microsoft Entra ID. Este ID único para la cuenta de Azure Maps puede obtenerse desde la API de la cuenta Azure Maps plano de gestión. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar la autenticación en Azure Maps. |
|
| Accept-Language |
string |
Idioma en el que se deben devolver los resultados de enrutamiento. Para más información, consulte Soporte de localización en Azure Maps. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK | RouteOperationResponse: |
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 result
Solicitud de ejemplo
GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01
Respuesta de muestra
{
"type": "Feature",
"geometry": null,
"kind": "RouteMatrix",
"properties": {
"matrix": [
{
"arrivalAt": "2022-12-20T00:21:14+01:00",
"departureAt": "2022-12-19T16:39:57+01:00",
"destinationIndex": 0,
"distanceInMeters": 573064,
"durationInSeconds": 27677,
"durationTrafficInSeconds": 27677,
"originIndex": 0,
"statusCode": 200
},
{
"destinationIndex": 1,
"error": {
"code": "OUT_OF_REGION",
"message": "Input coordinates out of region"
},
"originIndex": 0,
"statusCode": 400
},
{
"arrivalAt": "2022-12-19T22:19:10+01:00",
"departureAt": "2022-12-19T16:39:57+01:00",
"destinationIndex": 0,
"distanceInMeters": 452488,
"durationInSeconds": 20353,
"durationTrafficInSeconds": 20353,
"originIndex": 1,
"statusCode": 200
},
{
"destinationIndex": 1,
"error": {
"code": "OUT_OF_REGION",
"message": "Input coordinates out of region"
},
"originIndex": 1,
"statusCode": 400
}
],
"summary": {
"successfulCount": 2,
"totalCount": 4
}
}
}
{
"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. |
|
Features |
Especifica el tipo de |
|
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 |
Especifica las instrucciones de conducción y propiedades adicionales para cada punto de maniobra de la pierna de ruta. |
|
Route |
Propiedades de la matriz de rutas. |
|
Route |
Resultado del elemento Route Matrix |
|
Route |
Resumen de la solicitud de matriz de rutas |
|
Route |
Tipo de 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. |
FeaturesItemTypeEnum
Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, vea RFC 7946.
| Valor | Description |
|---|---|
| Feature |
Especifica el tipo de objeto feature de |
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 |
Una representación en lenguaje natural 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. |
RouteMatrixAsyncResponse
Especifica las instrucciones de conducción y propiedades adicionales para cada punto de maniobra de la pierna de ruta.
| Nombre | Tipo | Description |
|---|---|---|
| geometry |
El objeto geometry es null |
|
| kind |
string:
Route |
Tipo de operación asincrónica |
| properties |
Propiedades de la matriz de rutas. |
|
| type |
Especifica el tipo de |
RouteMatrixFeatureProperties
Propiedades de la matriz de rutas.
| Nombre | Tipo | Description |
|---|---|---|
| matrix |
Matriz de resultados de ruta. |
|
| summary |
Resumen de la solicitud de matriz de rutas |
RouteMatrixItemResult
Resultado del elemento Route Matrix
| Nombre | Tipo | Description |
|---|---|---|
| arrivalAt |
string (date-time) |
La hora estimada de llegada, que tiene en cuenta las condiciones de tráfico, tiene el formato de un valor |
| departureAt |
string (date-time) |
La hora estimada de salida, que tiene en cuenta las condiciones de tráfico, tiene el formato de un valor |
| destinationIndex |
integer (int32) |
Índice del punto de destino |
| distanceInMeters |
number (double) |
Length In Meters (propiedad) |
| durationInSeconds |
integer (int64) |
Tiempo estimado de viaje en segundos que no incluye retrasos en la ruta debido a las condiciones de tráfico. |
| durationTrafficInSeconds |
integer (int64) |
El tiempo que tarda, en segundos, en viajar un |
| error |
Detalle del error. |
|
| originIndex |
integer (int32) |
Índice del punto de origen |
| statusCode |
integer (int32) |
Código de estado HTTP de la celda actual. |
RouteMatrixSummary
Resumen de la solicitud de matriz de rutas
| Nombre | Tipo | Description |
|---|---|---|
| successfulCount |
integer (int32) |
Número de rutas correctas dentro de esta matriz. |
| totalCount |
integer (int32) |
Número total de rutas dentro de esta matriz. |
RouteOperationKindEnum
Tipo de operación asincrónica
| Valor | Description |
|---|---|
| RouteMatrix |
Trabajo asincrónico de matriz de rutas. |