Route - Get Route Operations Status

Obtenez le statut d’une opération asynchrone par son identifiant d’opération.

GET {endpoint}/route/operations/{id}?api-version=2025-01-01

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
path True

string

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}$

Identificateur unique généré par le système pour l’opération asynchrone une fois qu’elle a été soumise.

api-version
query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

RouteOperation

La demande a réussi.

404 Not Found

MapsErrorResponse

Le serveur ne trouve pas la ressource demandée.

Other Status Codes

MapsErrorResponse

Réponse d’erreur inattendue.

Sécurité

AadToken

Ce sont les flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès basé sur Azure par rôle, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès basés sur les rôles Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes ou sous-ressources de ressources Azure Maps. Tout utilisateur, groupe ou principal de service peut se voir accorder un accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs permissions pour Azure Maps les API REST.\n\nPour implémenter des scénarios, nous recommandons de consulter les concepts d’authentification . En résumé, cette définition de sécurité offre une solution pour modéliser l’application via des objets capables de contrôler l’accès sur des API et des périmètres spécifiques.\n\n#### Notes\n* Cette définition de sécurité exige l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accédre. Cela peut être acquis via l’API de gestion Maps.\n* \nLe Authorization URL est spécifique à l’instance Azure cloud public. Les clouds souverains disposent d’URL d’autorisation uniques et de configurations d’identifiants Microsoft Entra ID. \n* \nLe contrôle d’accès basé sur les rôles Azure est configuré depuis le plan de gestion Azure via Azure portail, PowerShell, CLI, SDK Azure ou API REST.\n* \nUtilisation du Azure Maps Web SDK permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.\n* Pour plus d’informations sur Plateforme d'identités Microsoft, voir Plateforme d'identités Microsoft aperçu .

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
https://atlas.microsoft.com/.default

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lorsque vous Créez un compte Azure Maps dans le portail Azure ou en utilisant PowerShell, CLI, SDK Azure ou API REST.\n\n Avec cette clé, toute application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme une clé maîtresse dans le compte où elle est émise.\n\n Pour les applications exposées publiquement, notre recommandation est d’utiliser l’approche applications clientes confidentielles pour accéder Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: header

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via Azure portail, PowerShell, CLI, SDK Azure ou API REST.\n\n Avec ce jeton, toute application est autorisée à y accéder avec Azure contrôles d’accès basés sur les rôles et un contrôle précis de l’expiration, du taux et des régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAS peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.\n\n Pour les applications publiquement exposées, notre recommandation est de configurer une liste spécifique des origines autorisées sur la ressource du compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAS.

Type: apiKey
Dans: header

Exemples

Retrieve the async matrix operation status

Exemple de requête

GET {endpoint}/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01

Exemple de réponse

{
  "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."
  }
}

Définitions

Nom Description
CommonErrorDetail

Détail de l’erreur.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

MapsErrorDetail

Détail de l’erreur.

MapsErrorResponse

Réponse à l’erreur courante pour les API Azure Maps afin de renvoyer les détails d’erreur en cas d’échec des opérations.

MapsInnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

RouteOperation

Cet objet est retourné à partir d’une demande Get Operation réussie.

RouteOperationKindEnum

Type d’opération asynchrone

RouteOperationResult

Le résultat d’une opération asynchrone

StatusEnum

État actuel de l’opération asynchrone.

CommonErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d’erreur.

details

CommonErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.

type

string

Type d’informations supplémentaire.

MapsErrorDetail

Détail de l’erreur.

Nom Type Description
code

string

Un ensemble de codes d’erreur définis par le serveur.

details

MapsErrorDetail[]

Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.

innererror

MapsInnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

message

string

Représentation lisible par l’homme de l’erreur.

target

string

Cible de l’erreur.

MapsErrorResponse

Réponse à l’erreur courante pour les API Azure Maps afin de renvoyer les détails d’erreur en cas d’échec des opérations.

Nom Type Description
error

MapsErrorDetail

Détail de l’erreur.

MapsInnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

Nom Type Description
code

string

Code d’erreur.

innererror

MapsInnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

RouteOperation

Cet objet est retourné à partir d’une demande Get Operation réussie.

Nom Type Description
createdAt

string (date-time)

Heure de création de l’opération.

error

CommonErrorDetail

Détail de l’erreur.

id

string

Identifiant unique pour l’opération asynchrone.

kind

RouteOperationKindEnum

Type d’opération asynchrone

lastActionAt

string (date-time)

Horodatage de la mise à jour de l’état de l’opération.

result

RouteOperationResult

Le résultat d’une opération asynchrone

status

StatusEnum

État actuel de l’opération asynchrone.

RouteOperationKindEnum

Type d’opération asynchrone

Valeur Description
RouteMatrix

Tâche asynchrone de matrice de routage.

RouteOperationResult

Le résultat d’une opération asynchrone

Nom Type Description
resultUrl

string (uri)

URL pour obtenir le résultat de l’opération asynchrone

StatusEnum

État actuel de l’opération asynchrone.

Valeur Description
NotStarted

L’opération n’a pas encore commencé.

Running

L’opération est en cours.

Completed

L’opération s’est terminée avec succès.

Failed

L’opération a échoué.