Render - Get Map Tileset

Usare per ottenere i metadati per un set di riquadri.
L'API Get Map Tileset consente agli utenti di richiedere metadati per un set di riquadri.

GET {endpoint}/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
path True

string (uri)

Il nome host del servizio Mappe di Azure. Usa https://atlas.microsoft.com per il cloud pubblico Azure. Per puntare a una specifica Mappe di Azure geografica o a una nuvola sovrana, vedi Mappe di Azure ambito geografico.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

tilesetId
query True

TilesetID

Un set di tessere è una raccolta di dati raster o vettoriali suddivisi in una griglia uniforme di riquadri quadrati a livelli di zoom predefiniti. Ogni set di riquadri ha un tilesetId da usare durante l'esecuzione di richieste. I tileset pronti all'uso forniti da Mappe di Azure sono elencati di seguito. Ad esempio, microsoft.base.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-id

string

Indica l'account destinato all'uso con il modello di sicurezza Microsoft Entra ID. Questo ID univoco per l'account Mappe di Azure può essere ottenuto dall'Account API Mappe di Azure piano di gestione. Per maggiori informazioni sull'uso della sicurezza Microsoft Entra ID in Mappe di Azure, vedi Gestire l'autenticazione in Mappe di Azure.

Risposte

Nome Tipo Descrizione
200 OK

MapTileset

La richiesta ha avuto esito positivo.

Other Status Codes

ErrorResponse

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-id per 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

Successful Tileset Request

Esempio di richiesta

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base

Risposta di esempio

{
  "attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">&copy;2022 TomTom</a>",
  "bounds": [
    -180,
    -90,
    180,
    90
  ],
  "maxzoom": 22,
  "minzoom": 0,
  "scheme": "xyz",
  "tilejson": "2.2.0",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
  ],
  "version": "1.0.0"
}

Definizioni

Nome Descrizione
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta comune all'errore per tutte le API di Azure Resource Manager per restituire dettagli di errore per operazioni fallite. Questo segue anche il formato di risposta di errore OData.

MapTileset

Metadati per un set di riquadri nel formato TileJSON.

TilesetID

Un set di tessere è una raccolta di dati raster o vettoriali suddivisi in una griglia uniforme di riquadri quadrati a livelli di zoom predefiniti. Ogni set di riquadri ha un tilesetId da usare durante l'esecuzione di richieste. I tileset pronti all'uso forniti da Mappe di Azure sono elencati di seguito. Ad esempio, microsoft.base.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

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 comune all'errore per tutte le API di Azure Resource Manager per restituire dettagli di errore per operazioni fallite. Questo segue anche il formato di risposta di errore OData.

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

MapTileset

Metadati per un set di riquadri nel formato TileJSON.

Nome Tipo Descrizione
attribution

string

Attribuzione del copyright da visualizzare sulla mappa. Le implementazioni POSSONO decidere di trattarlo come testo HTML o letterale. Per motivi di sicurezza, assicurarsi assolutamente che questo campo non possa essere abusato come vettore per il rilevamento XSS o beacon.

bounds

number[] (float)

Estensione massima dei riquadri della mappa disponibili. I limiti DEVONO definire un'area coperta da tutti i livelli di zoom. I limiti sono rappresentati nei valori di latitudine e longitudine WGS:84, nell'ordine sinistro, inferiore, destro, superiore. I valori possono essere numeri interi o a virgola mobile.

center

number[] (float)

Posizione predefinita del set di riquadri nel formato [longitudine, latitudine, zoom]. Il livello di zoom DEVE essere compreso tra minzoom e maxzoom. Le implementazioni possono usare questo valore per impostare il percorso predefinito.

data

string[]

Matrice di file di dati in formato GeoJSON.

description

string

Descrizione del set di riquadri. La descrizione può contenere qualsiasi carattere legale. Le implementazioni NON DEVONO interpretare la descrizione come HTML.

grids

string[]

Matrice di endpoint di interattività.

legend

string

Legenda da visualizzare con la mappa. Le implementazioni POSSONO decidere di trattarlo come testo HTML o letterale. Per motivi di sicurezza, assicurarsi assolutamente che questo campo non possa essere abusato come vettore per il rilevamento XSS o beacon.

maxzoom

integer (int32)

minimum: 0
maximum: 30

Livello di zoom massimo.

minzoom

integer (int32)

minimum: 0
maximum: 30

Livello di zoom minimo.

name

string

Nome che descrive il set di tessere. Il nome può contenere qualsiasi carattere legale. Le implementazioni NON DEVONO interpretare il nome come HTML.

scheme

string

Impostazione predefinita: "xyz". "xyz" o "tms". Influenza la direzione y delle coordinate del riquadro. Si presuppone il profilo global-mercator (noto anche come Spherical Mercator).

template

string

Modello mustache da usare per formattare i dati dalle griglie per l'interazione.

tilejson

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

Descrive la versione della specifica TileJSON implementata da questo oggetto JSON.

tiles

string[]

Matrice di endpoint riquadro. Se vengono specificati più endpoint, i client possono usare qualsiasi combinazione di endpoint. Tutti gli endpoint DEVONO restituire lo stesso contenuto per lo stesso URL. La matrice DEVE contenere almeno un endpoint.

version

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

Un semver.org numero di versione dello stile per i riquadri contenuti nel set di riquadri. Quando vengono introdotte modifiche tra riquadri, la versione secondaria DEVE cambiare.

TilesetID

Un set di tessere è una raccolta di dati raster o vettoriali suddivisi in una griglia uniforme di riquadri quadrati a livelli di zoom predefiniti. Ogni set di riquadri ha un tilesetId da usare durante l'esecuzione di richieste. I tileset pronti all'uso forniti da Mappe di Azure sono elencati di seguito. Ad esempio, microsoft.base.

Valore Descrizione
microsoft.base

Una mappa di base è una mappa standard che visualizza strade, caratteristiche naturali e artificiali insieme alle etichette per tali caratteristiche in un riquadro vettoriale.

Supporta i livelli di zoom da 0 a 22. Formato: vettore (pbf).

microsoft.base.labels

Visualizza le etichette per strade, caratteristiche naturali e artificiali in un riquadro vettoriale.

Supporta i livelli di zoom da 0 a 22. Formato: vettore (pbf).

microsoft.base.hybrid

Visualizza i dati di strada, limite e etichetta in un riquadro vettoriale.

Supporta i livelli di zoom da 0 a 22. Formato: vettore (pbf).

microsoft.terra.main

Rilievo ombreggiato e strati terra.

Supporta i livelli di zoom da 0 a 6. Formato: raster (png).

microsoft.base.road

Tutti i livelli con il nostro stile principale.

Supporta i livelli di zoom da 0 a 22. Formato: raster (png).

microsoft.base.darkgrey

Tutti i livelli con il nostro stile grigio scuro.

Supporta i livelli di zoom da 0 a 22. Formato: raster (png).

microsoft.base.labels.road

Etichettare i dati nello stile principale.

Supporta i livelli di zoom da 0 a 22. Formato: raster (png).

microsoft.base.labels.darkgrey

Etichettare i dati nello stile grigio scuro.

Supporta i livelli di zoom da 0 a 22. Formato: raster (png).

microsoft.base.hybrid.road

Dati su strada, limiti e etichette nello stile principale.

Supporta i livelli di zoom da 0 a 22. Formato: raster (png).

microsoft.base.hybrid.darkgrey

Dati su strada, limiti e etichette nello stile grigio scuro.

Supporta i livelli di zoom da 0 a 22. Formato: raster (png).

microsoft.imagery

Combinazione di immagini satellitari o aeree. Disponibile solo nello SKU dei prezzi di S1 e G2.

Supporta i livelli di zoom da 1 a 19. Formato: raster (png).

microsoft.weather.radar.main

Riquadri radar meteo. Ultime immagini radar meteo, tra cui aree di pioggia, neve, ghiaccio e condizioni miste. Per maggiori informazioni sulla copertura del servizio meteorologico Mappe di Azure, vedi Mappe di Azure copertura dei servizi meteorologici. Per maggiori informazioni sui dati radar, vedi Servizi meteorologici in Mappe di Azure.

Supporta i livelli di zoom da 0 a 15. Formato: raster (png).

microsoft.weather.infrared.main

Piastrelle a infrarossi meteo. Le immagini satellite a infrarossi più recenti mostrano le nuvole in base alla temperatura. Per ulteriori informazioni, consulta Mappe di Azure copertura dei servizi meteorologici. Per maggiori informazioni sui dati satellitari restituiti, vedi Servizi meteorologici in Mappe di Azure.

Supporta i livelli di zoom da 0 a 15. Formato: raster (png).

microsoft.traffic.absolute

riquadri di traffico assoluti nel vettore

microsoft.traffic.absolute.main

riquadri di traffico assoluti in raster nello stile principale.

microsoft.traffic.relative

riquadri relativi del traffico nel vettore

microsoft.traffic.relative.main

riquadri relativi del traffico in raster nello stile principale.

microsoft.traffic.relative.dark

riquadri relativi del traffico in raster nello stile scuro.

microsoft.traffic.delay

riquadri del traffico nel vettore

microsoft.traffic.delay.main

riquadri del traffico in raster nello stile principale

microsoft.traffic.reduced.main

riduzione dei riquadri del traffico in raster nello stile principale

microsoft.traffic.incident

riquadri degli eventi imprevisti nel vettore