Condividi tramite

Data - Get Operation

  • Riferimento
Servizio:
Maps
Versione API:
2.0

Usare per controllare lo stato di una richiesta di caricamento dati e ottenere il udid valore al termine.

Nota

Ritiro del servizio dati di Mappe di Azure

Il servizio dati di Mappe di Azure ( v1 e v2) è ora deprecato e verrà ritirato il 16/9/24. Per evitare interruzioni del servizio, tutte le chiamate al servizio dati dovranno essere aggiornate per usare il servizio Registro dati di Mappe di Azure entro il 16/09/24. Per altre informazioni, vedere Come creare il Registro di sistema dei dati.

L'API Get Operation è una richiesta HTTP GET che consente al chiamante di controllare lo stato di un'operazione di caricamento dati e ottenere il udid valore una volta completato. Questo percorso verrà ottenuto da una chiamata a POST /mapData. Mentre è in corso, viene restituito un codice di risposta HTTP 200 senza intestazioni aggiuntive, seguito da un codice di risposta HTTP 200 con un'intestazione Resource-Location completata correttamente.

Importante

Usando questa funzionalità, si accettano le condizioni legali di anteprima. Per altri dettagli, vedere Le condizioni supplementari per l'anteprima .

GET https://{geography}.atlas.microsoft.com/mapData/operations/{operationId}?api-version=2.0

Parametri dell'URI

Nome In Necessario Tipo Descrizione
geography
 path True

string

Questo parametro specifica dove si trova la risorsa Creator di Mappe di Azure. I valori validi sono noi ed eu.
operationId
 path True

string

ID per eseguire una query sullo stato della richiesta di caricamento dei dati.
api-version
 query True

string

Numero di versione dell'API Mappe di Azure.

Risposte

Nome Tipo Descrizione
200 OK

LongRunningOperationResult

L'operazione è in esecuzione o completata. Se l'operazione ha avuto esito positivo, usare l'intestazione Resource-Location per ottenere il percorso del risultato.

Intestazioni

Resource-Location: string
Other Status Codes

ErrorResponse

Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi Microsoft Entra OAuth 2.0 . Se abbinato al controllo degli accessi in base al ruolo di Azure , può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più account di risorse di Mappe di Azure o a risorse secondarie. 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 i 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-id per indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe .

è Authorization URL specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni ID Microsoft Entra. * 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 di Azure Maps Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Tipo: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Descrizione
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si crea un account 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 alle 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: query

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione Elenca firma di accesso condiviso nella risorsa 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 con i controlli di accesso in base al ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle 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 dell'account map per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

Get the status of an operation which has finished successfully
Get the status of an operation which is still running

Get the status of an operation which has finished successfully

Sample request

GET https://us.atlas.microsoft.com/mapData/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

Sample response

Status code:
200 
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Get the status of an operation which is still running

Sample request

GET https://us.atlas.microsoft.com/mapData/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

Sample response

Status code:
200 
{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-23T19:14:03.2452596+00:00",
  "status": "Running"
}

Definizioni

Nome Descrizione
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
LongRunningOperationResult

Modello di risposta per un'API operations di Long-Running.
LroStatus

Stato della richiesta.

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

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
details

ErrorDetail[]

Dettagli dell'errore.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

LongRunningOperationResult

Modello di risposta per un'API operations di Long-Running.

Nome Tipo Descrizione
created

string

Timestamp creato.
error

ErrorDetail

Dettagli dell'errore.
operationId

string

ID per questa operazione a esecuzione prolungata.
status

LroStatus

Stato della richiesta.
warning

ErrorDetail

Dettagli dell'errore.

LroStatus

Stato della richiesta.

Nome Tipo Descrizione
Failed

string

La richiesta presenta uno o più errori.
NotStarted

string

La richiesta non ha ancora avviato l'elaborazione.
Running

string

La richiesta ha avviato l'elaborazione.
Succeeded

string

La richiesta è stata completata correttamente.