Route - Get Route Operations Status
Obtenez l’état d’une opération asynchrone par son ID d’opération.
GET https://atlas.microsoft.com/route/operations/{id}?api-version=2025-01-01
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
id
|
path | True |
string minLength: 36maxLength: 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. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
Ok |
|
| 404 Not Found |
La ressource d’opération est introuvable. En-têtes x-ms-error-code: string |
|
| Other Status Codes |
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-idpour 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 URLest 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 operation status
Exemple de requête
GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01
Exemple de réponse
{
"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."
}
}
Définitions
| Nom | Description |
|---|---|
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
|
Error |
Détail de l’erreur. |
|
Error |
Réponse d’erreur |
| Result |
Résultat d’une opération asynchrone |
|
Route |
Cet objet est renvoyé à partir d’une demande d’opération Get réussie . |
|
Route |
Type d’opération asynchrone |
|
Status |
État actuel de l’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 |
Informations supplémentaires sur l’erreur. |
|
| code |
string |
Code d’erreur. |
| details |
Détails de l’erreur. |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
Result
Résultat d’une opération asynchrone
| Nom | Type | Description |
|---|---|---|
| resultUrl |
string (uri) |
URL pour obtenir le résultat de l’opération asynchrone |
RouteOperation
Cet objet est renvoyé à partir d’une demande d’opération Get réussie .
| Nom | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
Horodatage lors de la création de l’opération. |
| error |
Détail de l’erreur. |
|
| id |
string |
Identificateur unique de l’opération asynchrone. |
| kind |
Type d’opération asynchrone |
|
| lastActionAt |
string (date-time) |
Horodatage de la mise à jour de l’état de l’opération. |
| result |
Résultat d’une opération asynchrone |
|
| status |
État actuel de l’opération asynchrone. |
RouteOperationKindEnum
Type d’opération asynchrone
| Valeur | Description |
|---|---|
| RouteMatrix |
Tâche asynchrone de matrice de routage. |
StatusEnum
État actuel de l’opération asynchrone.
| Valeur | Description |
|---|---|
| NotStarted |
L’opération n’a pas encore démarré. |
| Running |
L’opération est en cours d’exécution. |
| Completed |
L’opération s’est terminée avec succès. |
| Failed |
L’opération a échoué. |