Partager via


Route - Get Route Operations Result

Obtenez le résultat d’une opération asynchrone par son ID d’opération.

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

Paramètres URI

Nom Dans Obligatoire Type 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}$

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

Numéro de version de l’API Azure Maps.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-id

string

Indique le compte destiné à être utilisé avec le modèle de sécurité Microsoft Entra ID. Cet ID unique pour le compte Azure Maps peut être obtenu à partir de l’API de compte du plan de gestion Azure Maps. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, consultez Gérer l’authentification dans Azure Maps.

Accept-Language

string

Langue dans laquelle les résultats de routage doivent être retournés.

Pour plus d’informations, consultez prise en charge de la localisation dans Azure Maps.

Réponses

Nom Type Description
200 OK RouteOperationResponse:

RouteMatrixAsyncResponse

Ok

404 Not Found

MapsErrorResponse

Le résultat de la ressource d’opération est introuvable.

En-têtes

x-ms-error-code: string

Other Status Codes

MapsErrorResponse

Une erreur inattendue s’est produite.

En-têtes

x-ms-error-code: string

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Remarque

  • Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps.
  • La Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra.
  • Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
  • L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
  • Pour plus d’informations sur la plateforme d’identités Microsoft, consultez vue d’ensemble de la plateforme d’identités Microsoft.

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

Étendues

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

subscription-key

Il s’agit d’une clé partagée provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, ces clés peuvent être traitées comme des clés principales pour le compte pour lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès serveur à serveur des API REST Azure Maps où cette clé peut ê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 le portail Azure, PowerShell, CLI, azure SDK ou LES API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP 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.

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Retrieve the async matrix result

Exemple de requête

GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01

Exemple de réponse

{
  "kind": "RouteMatrix",
  "type": "Feature",
  "geometry": null,
  "properties": {
    "summary": {
      "totalCount": 4,
      "successfulCount": 2
    },
    "matrix": [
      {
        "statusCode": 200,
        "originIndex": 0,
        "destinationIndex": 0,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-20T00:21:14+01:00",
        "distanceInMeters": 573064,
        "durationInSeconds": 27677,
        "durationTrafficInSeconds": 27677
      },
      {
        "statusCode": 400,
        "originIndex": 0,
        "destinationIndex": 1,
        "error": {
          "code": "OUT_OF_REGION",
          "message": "Input coordinates out of region"
        }
      },
      {
        "statusCode": 200,
        "originIndex": 1,
        "destinationIndex": 0,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-19T22:19:10+01:00",
        "distanceInMeters": 452488,
        "durationInSeconds": 20353,
        "durationTrafficInSeconds": 20353
      },
      {
        "statusCode": 400,
        "originIndex": 1,
        "destinationIndex": 1,
        "error": {
          "code": "OUT_OF_REGION",
          "message": "Input coordinates out of region"
        }
      }
    ]
  }
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

Définitions

Nom Description
ErrorAdditionalInfo

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

ErrorDetail

Détail de l’erreur.

FeaturesItemTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est Feature. Pour plus d’informations, consultez la RFC 7946.

MapsErrorDetail

Détail de l’erreur.

MapsErrorResponse

Réponse d’erreur courante pour les API Azure Maps pour retourner les détails d’erreur pour les opérations ayant échoué.

MapsInnerError

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

RouteMatrixAsyncResponse

Spécifie les instructions de conduite et les propriétés supplémentaires pour chaque point de manœuvre dans la jambe de route.

RouteMatrixFeatureProperties

Propriétés de matrice de routage.

RouteMatrixItemResult

Résultat de l’élément De matrice de routage

RouteMatrixSummary

Résumé de la demande de matrice de routage

RouteOperationKindEnum

Type d’opération asynchrone

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.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d’erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

FeaturesItemTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est Feature. Pour plus d’informations, consultez la RFC 7946.

Valeur Description
Feature

Spécifie le type d’objet Feature GeoJSON.

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

Une représentation lisible par une personne de l'erreur.

target

string

Cible de l’erreur.

MapsErrorResponse

Réponse d’erreur courante pour les API Azure Maps pour retourner les détails d’erreur pour les opérations ayant échoué.

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.

RouteMatrixAsyncResponse

Spécifie les instructions de conduite et les propriétés supplémentaires pour chaque point de manœuvre dans la jambe de route.

Nom Type Description
geometry

object

L’objet geometry a la valeur Null

kind string:

RouteMatrix

Type d’opération asynchrone

properties

RouteMatrixFeatureProperties

Propriétés de matrice de routage.

type

FeaturesItemTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est Feature. Pour plus d’informations, consultez la RFC 7946.

RouteMatrixFeatureProperties

Propriétés de matrice de routage.

Nom Type Description
matrix

RouteMatrixItemResult[]

Matrice des résultats de l’itinéraire.

summary

RouteMatrixSummary

Résumé de la demande de matrice de routage

RouteMatrixItemResult

Résultat de l’élément De matrice de routage

Nom Type Description
arrivalAt

string (date-time)

L’heure d’arrivée estimée, qui prend en compte les conditions de trafic, est mise en forme sous forme de valeur dateTime définie par RFC 3339, section 5.6. Il référencera le décalage du fuseau horaire par departAt ou arrivalAt. Si ce n’est pas le cas, l’heure UTC sera utilisée. Si departAt ou arriveAt est l’un des cas, departureAt est absent.

departureAt

string (date-time)

Le temps de départ estimé, qui prend en compte les conditions de trafic, est mis en forme comme valeur de dateTime définie par RFC 3339, section 5.6. Il référencera le décalage du fuseau horaire par departAt ou arrivalAt. Si ce n’est pas le cas, l’heure UTC sera utilisée. Si departAt ou arriveAt est any, alors departureAt est absent.

destinationIndex

integer (int32)

Index du point de destination

distanceInMeters

number (double)

Length In Meters, propriété

durationInSeconds

integer (int64)

Temps de trajet estimé en secondes qui n’inclut pas de retards sur l’itinéraire en raison de conditions de trafic.

durationTrafficInSeconds

integer (int64)

Temps nécessaire, en secondes, pour parcourir un TravelDistance correspondant avec les conditions de trafic actuelles. Cette valeur est fournie si optimizeRoute inclut des considérations sur le trafic.

error

ErrorDetail

Détail de l’erreur.

originIndex

integer (int32)

Index du point d’origine

statusCode

integer (int32)

Code d’état HTTP de la cellule active.

RouteMatrixSummary

Résumé de la demande de matrice de routage

Nom Type Description
successfulCount

integer (int32)

Nombre d’itinéraires réussis dans cette matrice.

totalCount

integer (int32)

Nombre total d’itinéraires dans cette matrice.

RouteOperationKindEnum

Type d’opération asynchrone

Valeur Description
RouteMatrix

Tâche asynchrone de matrice de routage.