Data - List

Riferimento

Servizio:: Maps

Versione API:: 2.0

Usare per recuperare un elenco di tutti i contenuti caricati in precedenza usando Caricamento dati.

Nota

Ritiro del servizio dati di Mappe di Azure

Il servizio dati mappe di Azure ( sia v1 che v2 ) è ora deprecato e verrà ritirato il 9/16/ 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 9/16/24. Per altre informazioni, vedere Come creare il Registro dati.

L'API Data List è una richiesta HTTP GET che consente al chiamante di recuperare un elenco di tutti i contenuti caricati in precedenza usando l'API Caricamento dati .

Invia richiesta elenco

Per elencare tutti i contenuti dei dati della mappa, verrà eseguita una GET richiesta senza parametri aggiuntivi.

Elencare la risposta ai dati

L'API Elenco dati restituisce l'elenco completo di tutti i dati in json formato. La risposta contiene i dettagli seguenti per ogni risorsa dati:

udid: ID dati univoco per la risorsa dati.

location: posizione della risorsa dati. Eseguire una richiesta HTTP GET in questo percorso per scaricare i dati.

Ecco una risposta di esempio che restituisce le udid risorse dati e location di 3:

{
    "mapDataList": 
    [
        {
            "udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0",
            "sizeInBytes": 29920,
            "uploadStatus": "Completed"
        },
        {
            "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
            "sizeInBytes": 1339,
            "uploadStatus": "Completed"
        },
        {
            "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
            "sizeInBytes": 1650,
            "uploadStatus": "Pending"
        }]
}

GET https://{geography}.atlas.microsoft.com/mapData?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.
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 del piano di gestione 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	MapDataListResult	Elencare la richiesta di dati completata correttamente. Il corpo della risposta contiene un elenco di tutti i dati caricati in precedenza.
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi di Microsoft Entra OAuth 2.0 . Quando è associato 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 basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più account delle risorse delle risorse di Mappe di Azure o alle sotto-risorse. 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 riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare la risorsa mappe di Azure a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe .

L'oggetto Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani dispongono di URL di autorizzazione univoci e configurazioni di 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 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 eseguito 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 delle 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 List SAS nella risorsa mappe 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 basati sul 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 account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

List all the previously uploaded data

Sample request

HTTP

GET https://us.atlas.microsoft.com/mapData?api-version=2.0

Sample response

Status code:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://us.atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0",
      "sizeInBytes": 29920,
      "uploadStatus": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "location": "https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
      "sizeInBytes": 1339,
      "uploadStatus": "Completed"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "location": "https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

Definizioni

Nome	Descrizione
DataFormat	Formato dati del contenuto caricato.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
MapData	Informazioni dettagliate per i dati.
MapDataListResult	Modello di risposta per l'API Elenco dati. Restituisce un elenco di tutti i dati caricati in precedenza.
UploadStatus	Stato di caricamento corrente del contenuto.

DataFormat

Formato dati del contenuto caricato.

Nome	Tipo	Descrizione
dwgzippackage	string	Pacchetto ZIP contenente il file DWG.
geojson	string	GeoJSON è un formato di interscambio dati geospaziali basato su JSON.
zip	string	Formato dati compresso.

ErrorAdditionalInfo

Informazioni aggiuntive sulla 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.

MapData

Informazioni dettagliate per i dati.

Nome	Tipo	Descrizione
dataFormat	DataFormat	Formato dati del contenuto caricato.
description	string	Descrizione corrente.
location	string	Posizione dei dati. Eseguire una richiesta HTTP `GET` in questo percorso per scaricare i dati.
sizeInBytes	integer	Dimensioni del contenuto in byte.
udid	string	ID dati univoco per i dati.
uploadStatus	UploadStatus	Stato di caricamento corrente del contenuto.

MapDataListResult

Modello di risposta per l'API Elenco dati. Restituisce un elenco di tutti i dati caricati in precedenza.

Nome	Tipo	Descrizione
mapDataList	MapData[]	Elenco di tutti i dati caricati in precedenza.

UploadStatus

Stato di caricamento corrente del contenuto.

Nome	Tipo	Descrizione
Completed	string	Caricare la convalida e l'elaborazione completata
Failed	string	Caricare la convalida e/o l'errore di elaborazione
Pending	string	Caricamento in corso di elaborazione

Condividi tramite