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 |
|
|
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. Cualquier usuario, grupo o principal de servicio puede recibir acceso mediante un rol incorporado o un rol personalizado compuesto por uno o más permisos para Azure Maps APIs REST.\n\nPara implementar escenarios, recomendamos consultar conceptos autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones(es) mediante objetos capaces de control de acceso en APIs y ámbitos específicos.\n\n#### Notas\n* Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso Azure Maps solicita acceso la aplicación. Esto puede obtenerse de la API de gestión Maps.\n* \nEl Authorization URL es específico para la instancia Azure nube pública. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. \n* \nEl control de acceso basado en roles Azure se configura desde el plano de gestión Azure a través de Azure portal, PowerShell, CLI, SDK de Azure o APIs REST.\n* \nUso del Azure Maps Web SDK permite la configuración de una aplicación para múltiples casos de uso.\n* Para más información sobre Plataforma de identidad de Microsoft, véase Plataforma de identidad de Microsoft visión general.
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
Esta es una clave compartida que se provisiona cuando Crea una cuenta Azure Maps en el portal Azure o usando PowerShell, CLI, SDK de Azure o REST API.\n\n Con esta clave, cualquier aplicación puede acceder a toda la API REST. En otras palabras, esta clave puede usarse como una llave maestra en la cuenta en la que se emiten.\n\n Para aplicaciones expuestas públicamente, nuestra recomendación es utilizar el enfoque
Tipo:
apiKey
En:
header
SAS Token
Este token de firma de acceso compartido se crea a partir de la operación List SAS en el recurso Azure Maps a través del plano de gestión de Azure mediante Azure portal, PowerShell, CLI, SDK de Azure o APIs REST.\n\n Con este token, cualquier aplicación está autorizada para acceder con Azure controles de acceso basados en roles y control detallado de la expiración, tasa y región(es) de uso para el token en particular. En otras palabras, el Token SAS puede usarse para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.\n\n Para aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta Map para limitar el abuso de renderizado y renovar regularmente el Token SAS.
Tipo:
apiKey
En:
header
Ejemplos
Retrieve the async matrix operation status
Solicitud de ejemplo
GET {endpoint}/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. |