Route - Get Route Operations Status
Ottieni lo stato di un'operazione asincrona tramite il suo ID operazione.
GET https://atlas.microsoft.com/route/operations/{id}?api-version=2025-01-01
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
id
|
path | True |
string minLength: 36maxLength: 36 pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Identificatore univoco generato dal sistema per l'operazione asincrona dopo che è stata inviata. |
|
api-version
|
query | True |
string |
Numero di versione di Azure Maps API. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
Va bene |
|
| 404 Not Found |
La risorsa operativa non fu trovata. Intestazioni x-ms-error-code: string |
|
| Other Status Codes |
Errore imprevisto. Intestazioni x-ms-error-code: string |
Sicurezza
AADToken
Questi sono i flussi Microsoft Entra OAuth 2.0. Quando abbinata al controllo Azure basato su ruolo può essere utilizzata per controllare l'accesso alle API REST di Azure Maps. I controlli di accesso basati su ruoli di Azure sono utilizzati per designare l'accesso a uno o più account o sottorisorse risorse di Azure Maps. Qualsiasi utente, gruppo o principale di servizio può ricevere l'accesso tramite un ruolo integrato o un ruolo personalizzato composto da uno o più permessi alle API REST di Azure Maps.
Per implementare scenari, è consigliabile visualizzare concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.
Annotazioni
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-idper indicare a quale Azure Maps risorsa l'applicazione richiede accesso. Questa operazione può essere acquisita dall'API di gestione di mappe . - Il
Authorization URLè specifico per l'istanza Azure cloud pubblico. I cloud sovrani hanno URL di autorizzazione unici e configurazioni Microsoft Entra ID. - Il controllo degli accessi basato sul ruolo Azure viene configurato dal piano di gestione Azure tramite portale Azure, PowerShell, CLI, Azure SDKs o API REST.
- L'uso del Web SDK Azure Maps consente la configurazione di un'applicazione per più casi d'uso.
- Per altre informazioni su Microsoft Identity Platform, vedere panoramica di Microsoft Identity Platform.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
| Nome | Descrizione |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Questa è una chiave condivisa che viene fornita quando si crea una risorsa Azure Maps tramite il piano di gestione Azure tramite Azure portale, PowerShell, CLI, Azure SDKs o API REST.
Con questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, questi possono essere attualmente considerati chiavi master per l'account per cui vengono rilasciati.
Per applicazioni pubblicamente esposte, la nostra raccomandazione è di utilizzare l'accesso server-to-server alle API REST di Azure Maps, dove questa chiave può essere memorizzata in modo sicuro.
Tipo:
apiKey
In:
header
SAS Token
Questo è un token di firma di accesso condiviso creato dall'operazione List SAS sulla risorsa Azure Maps tramite il piano di gestione Azure tramite Azure portale, PowerShell, CLI, Azure SDKs o API REST.
Con questo token, qualsiasi applicazione è autorizzata ad accedere tramite Azure ai controlli di accesso basati su ruoli e a un controllo fine della scadenza, del tasso e delle regioni di utilizzo per il particolare token. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.
Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.
Tipo:
apiKey
In:
header
Esempio
Retrieve the async matrix operation status
Esempio di richiesta
GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01
Risposta di esempio
{
"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."
}
}
Definizioni
| Nome | Descrizione |
|---|---|
|
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
|
Error |
Dettagli dell'errore. |
|
Error |
Risposta di errore |
| Result |
Il risultato di un'operazione asincrona |
|
Route |
Questo oggetto viene restituito da una richiesta Get Operation riuscita. |
|
Route |
Tipo di operazione asincrona |
|
Status |
Stato attuale dell'operazione asincrona. |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
| Nome | Tipo | Descrizione |
|---|---|---|
| info |
object |
Informazioni aggiuntive. |
| type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| additionalInfo |
Informazioni aggiuntive sull'errore. |
|
| code |
string |
Codice di errore. |
| details |
Dettagli dell'errore. |
|
| message |
string |
Messaggio di errore. |
| target |
string |
Destinazione dell'errore. |
ErrorResponse
Risposta di errore
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Oggetto error. |
Result
Il risultato di un'operazione asincrona
| Nome | Tipo | Descrizione |
|---|---|---|
| resultUrl |
string (uri) |
URL per ottenere il risultato dell'operazione asincrona |
RouteOperation
Questo oggetto viene restituito da una richiesta Get Operation riuscita.
| Nome | Tipo | Descrizione |
|---|---|---|
| createdAt |
string (date-time) |
Timestamp quando l'operazione è stata creata. |
| error |
Dettagli dell'errore. |
|
| id |
string |
Identificatore unico per l'operazione asincrona. |
| kind |
Tipo di operazione asincrona |
|
| lastActionAt |
string (date-time) |
Timestamp quando lo stato dell'operazione è stato aggiornato. |
| result |
Il risultato di un'operazione asincrona |
|
| status |
Stato attuale dell'operazione asincrona. |
RouteOperationKindEnum
Tipo di operazione asincrona
| Valore | Descrizione |
|---|---|
| RouteMatrix |
Processo asincrono della matrice di route. |
StatusEnum
Stato attuale dell'operazione asincrona.
| Valore | Descrizione |
|---|---|
| NotStarted |
L'operazione non è ancora iniziata. |
| Running |
L'operazione è in corso. |
| Completed |
L'operazione è stata completata correttamente. |
| Failed |
L'operazione non è riuscita. |