Compartir a través de


Route - Get Route Operations Status

Obtenga el estado de una operación asincrónica por su identificador de operación.

GET https://atlas.microsoft.com/route/operations/{id}?api-version=2025-01-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
id
path True

string

minLength: 36
maxLength: 36
pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

Identificador único generado por el sistema para la operación asincrónica después de que se haya enviado.

api-version
query True

string

Número de versión de la API de Azure Maps.

Respuestas

Nombre Tipo Description
200 OK

RouteOperation

De acuerdo

404 Not Found

ErrorResponse

No se encontró el recurso de operación.

Encabezados

x-ms-error-code: string

Other Status Codes

ErrorResponse

Error inesperado.

Encabezados

x-ms-error-code: string

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos 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 los 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.

Nota:

  • Esta definición de seguridad requiere el uso del encabezado para indicar a qué recurso de x-ms-client-id Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.
  • El Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra.
  • 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 https://atlas.microsoft.com/.default

subscription-key

Se trata de una clave compartida que se aprovisiona al crear una 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 esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de las API REST de Azure Maps donde esta clave se puede 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

{
  "kind": "RouteMatrix",
  "status": "Completed",
  "createdAt": "2023-01-01T00:00:00Z",
  "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"
  }
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Definiciones

Nombre Description
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

Result

El resultado de la operación asíncrona

RouteOperation

Este objeto se devuelve de una solicitud Get Operation correcta.

RouteOperationKindEnum

Tipo de operación asincrónica

StatusEnum

Estado actual de la operación asincrónica.

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.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

Result

El resultado de la operación asíncrona

Nombre Tipo Description
resultUrl

string (uri)

URL para obtener el resultado de la operación asíncrona

RouteOperation

Este objeto se devuelve de una solicitud Get Operation correcta.

Nombre Tipo Description
createdAt

string (date-time)

Marca de tiempo cuando se creó la operación.

error

ErrorDetail

Detalle del error.

id

string

Identificador único de la operación asincrónica.

kind

RouteOperationKindEnum

Tipo de operación asincrónica

lastActionAt

string (date-time)

Marca de tiempo en la que se actualizó el estado de la operación.

result

Result

El resultado de la operación asíncrona

status

StatusEnum

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.

StatusEnum

Estado actual de la operación asincrónica.

Valor Description
NotStarted

La operación aún no se ha iniciado.

Running

La operación se está ejecutando.

Completed

La operación se ha completado correctamente.

Failed

La operación ha fallado.