Data - Download

Servizio:

Maps

Versione API:

2.0

Usare per scaricare i dati caricati in precedenza usando caricamento dati.

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 Data Download è e la richiesta HTTP GET che consente al chiamante di scaricare un contenuto di dati caricato in precedenza.

È possibile usare questa API in uno scenario come scaricare una raccolta esistente di recinti virtuali caricati in precedenza usando l'API Caricamento dati per l'uso nel servizio Geofencing di Mappe di Azure.

Importante

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

Invia richiesta di download

Per scaricare il contenuto si userà una GET richiesta in cui il percorso conterrà i udid dati da scaricare. Facoltativamente, è anche possibile passare un'intestazione Accept per specificare una preferenza per la Content-Type risposta ai dati.

Ad esempio, per scaricare una raccolta di recinti virtuali caricati in precedenza usando l'API Upload, impostare il udid parametro nel percorso dei udid dati ricevuti in precedenza nella risposta dell'API di caricamento e impostare l'intestazione Accept su uno dei tipi di supporto seguenti:

• application/json
• application/vnd.geo+json
• application/octet-stream

Scaricare la risposta ai dati

L'API download restituirà una risposta HTTP 200 OK se viene trovata la risorsa dati con il valore passato udid , in cui il corpo della risposta conterrà il contenuto della risorsa dati.

Se la risorsa dati con il passato udid non viene trovata, verrà restituita una risposta di errore HTTP400 Bad Request.

Ecco un corpo di risposta di esempio per un semplice recinto virtuale rappresentato in precedenza usando GeoJSON l'API Di caricamento:

{
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-122.126986, 47.639754]
        },
        "properties": {
            "geometryId": "001",
            "radius": 500
        }
    }]
}

GET https://{geography}.atlas.microsoft.com/mapData/{udid}?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.
udid	path	True	string	ID dati univoco per il contenuto. L'oggetto udid deve essere stato ottenuto da una chiamata di caricamento dati riuscita.
api-version	query	True	string	Numero di versione dell'API Mappe di Azure.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	file	Richiesta di download dei dati completata correttamente. Il corpo della risposta conterrà il contenuto per l'oggetto passato in udid. Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream" Intestazioni Content-Type: string
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto. Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

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.

• Per altre informazioni su Microsoft Identity Platform, vedere Panoramica di Microsoft Identity Platform.

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

Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences

Sample request

HTTP

GET https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2.0

Sample response

Status code:

200

"{file}"

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore

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.