Route - Get Route Operations Status
Ottieni lo stato di un'operazione asincrona tramite il suo ID operazione.
GET {endpoint}/route/operations/{id}?api-version=2025-01-01
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Il nome host del servizio Mappe di Azure. Usa |
|
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 minLength: 1 |
Versione dell'API da usare per questa operazione. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
La richiesta ha avuto esito positivo. |
|
| 404 Not Found |
Il server non riesce a trovare la risorsa richiesta. |
|
| Other Status Codes |
Risposta di errore imprevista. |
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 Mappe di Azure. I controlli di accesso basati su ruoli di Azure sono utilizzati per designare l'accesso a uno o più account o sottorisorse risorse di Mappe di Azure. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.
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.
Note
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-idper indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione di mappe . - Il
Authorization URLè specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione unici e configurazioni Microsoft Entra ID. - Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
- L'utilizzo della Sdk Web di Mappe di Azure consente la configurazione basata sulla 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 |
subscription-key
Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si Creare un account di Mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.
Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.
Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio applicazioni client riservate per accedere alle API REST di Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.
Tipo:
apiKey
In:
header
SAS Token
Si tratta di un token di firma di accesso condiviso creato dall'operazione List SAS nell'risorsa di Mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
Con questo token, qualsiasi applicazione è autorizzata ad accedere ai controlli di accesso in base al ruolo di Azure e al controllo granulare per la scadenza, la frequenza e le aree d'uso per il token specifico. 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
{
"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."
}
}
Definizioni
| Nome | Descrizione |
|---|---|
|
Common |
Dettagli dell'errore. |
|
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
|
Maps |
Dettagli dell'errore. |
|
Maps |
Risposta comune all'errore per le API di Mappe di Azure per restituire dettagli di errore per operazioni fallite. |
|
Maps |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
Route |
Questo oggetto viene restituito da una richiesta Get Operation riuscita. |
|
Route |
Tipo di operazione asincrona |
|
Route |
Il risultato di un'operazione asincrona |
|
Status |
Stato attuale dell'operazione asincrona. |
CommonErrorDetail
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. |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
| Nome | Tipo | Descrizione |
|---|---|---|
| info |
object |
Informazioni aggiuntive. |
| type |
string |
Tipo di informazioni aggiuntive. |
MapsErrorDetail
Dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Uno di un set definito dal server di codici di errore. |
| details |
Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato. |
|
| innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
| message |
string |
Rappresentazione leggibile dell'errore. |
| target |
string |
Destinazione dell'errore. |
MapsErrorResponse
Risposta comune all'errore per le API di Mappe di Azure per restituire dettagli di errore per operazioni fallite.
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Dettagli dell'errore. |
MapsInnerError
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Codice di errore. |
| innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
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. |
RouteOperationResult
Il risultato di un'operazione asincrona
| Nome | Tipo | Descrizione |
|---|---|---|
| resultUrl |
string (uri) |
URL per ottenere il risultato dell'operazione asincrona |
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. |