Tileset - List
Usare per ottenere un elenco di set di riquadri.
Invia richiesta elenco
L'API List
è una richiesta HTTP GET
usata per recuperare un elenco di tutti i set di riquadri esistenti.
GET https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
geography
|
path | True |
string |
Questo parametro specifica dove si trova la risorsa Mappe di Azure Creator. 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 Microsoft Entra ID sicurezza in Mappe di Azure vedere gli articoli seguenti per indicazioni. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Elencare la richiesta del set di riquadri completata correttamente. Il corpo della risposta contiene un elenco di tutti i set di riquadri. |
|
Other Status Codes |
Si è verificato un errore imprevisto. |
Sicurezza
AADToken
Si tratta dei flussi OAuth 2.0 Microsoft Entra. Quando è associato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account delle risorse 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 Mappe di Azure API REST.
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 quale Mappe di Azure risorsa 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 hanno URL di autorizzazione univoci e configurazioni Microsoft Entra ID.
* Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.
* L'utilizzo dell'SDK Web 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 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
Si tratta di una chiave condivisa di cui viene eseguito il provisioning quando si crea un account Mappe di Azure nell'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 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 Elenco firma di accesso condiviso nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o 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
Get a list of all tilesets
Esempio di richiesta
GET https://us.atlas.microsoft.com/tilesets?api-version=2.0
Risposta di esempio
{
"tilesets": [
{
"tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84",
"datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b",
"description": "My first tileset",
"minZoom": 16,
"maxZoom": 18,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
]
},
{
"tilesetId": "b8dca8b3-8aad-4afe-abd6-0efe37b5a2e3",
"datasetId": "c0a01139-662e-4d5a-bf5f-92ea4a292aad",
"description": "My second tileset",
"minZoom": 19,
"maxZoom": 19,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
]
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Informazioni aggiuntive sulla gestione delle risorse. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore |
Tileset |
Informazioni dettagliate per i dati. |
Tileset |
Modello di risposta per l'API Elenco riquadri. Restituisce un elenco di tutti i set di riquadri. |
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 |
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. |
Tileset
Informazioni dettagliate per i dati.
Nome | Tipo | Descrizione |
---|---|---|
bbox |
number[] |
Rettangolo di selezione che tutte le caratteristiche del set di riquadri si trovano all'interno. Proiezione usata : EPSG:3857. Formato : 'minLon, minLat, maxLon, maxLat'. |
datasetId |
string |
ID set di dati univoco usato per creare il set di riquadri. |
description |
string |
Descrizione del chiamante fornito durante la creazione del set di riquadri. Lunghezza massima 1024 caratteri. |
maxZoom |
integer |
Riquadro di zoom del riquadro più alto generato per il set di riquadri. |
minZoom |
integer |
Riquadro di zoom del riquadro più basso generato per il set di riquadri. |
ontology |
string |
Versione di ontologia di questo set di dati. |
tilesetId |
string |
ID del set di riquadri univoco per il set di riquadri. |
TilesetListResult
Modello di risposta per l'API Elenco riquadri. Restituisce un elenco di tutti i set di riquadri.
Nome | Tipo | Descrizione |
---|---|---|
nextLink |
string |
Se presente, il percorso della pagina successiva dei dati. |
tilesets |
Tileset[] |
Elenco di tutti i set di riquadri. |