Tileset - List

Riferimento

Servizio:: Maps Creator

Versione API:: 2023-03-01-preview

Usare per ottenere un elenco di set di tessere.

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=2023-03-01-preview

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 account 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	TilesetListResult	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	ErrorResponse	Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi OAuth2 di Azure Active Directory . Se abbinato 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 in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. 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 Mappe di Azure API REST.

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 Mappe di Azure risorsa a cui 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 di Azure Active Directory. * 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 di Mappe di Azure Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Attualmente Azure Active Directory v1.0 o v2.0 supporta account aziendali, dell'istituto di istruzione e guest, ma non supporta account personali.

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 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 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 piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, Azure SDK o 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 a list of all tilesets

Esempio di richiesta

HTTP

GET https://us.atlas.microsoft.com/tilesets?api-version=2023-03-01-preview

Risposta di esempio

Codice di stato:: 200

{
  "tilesets": [
    {
      "tilesetId": "{tilesetId}",
      "datasetId": "{datasetId}",
      "description": "My first tileset",
      "minZoom": 16,
      "maxZoom": 18,
      "bbox": [
        -122.13595,
        47.636524,
        -122.1329,
        47.637525
      ],
      "ontology": "facility-2.0",
      "tilesetConfiguration": {
        "version": 1,
        "layers": {
          "Indoor facility": {
            "minZoom": 13,
            "maxZoom": 20,
            "features": {
              "featureClasses": [
                "facility"
              ]
            }
          },
          "Indoor unit": {
            "minZoom": 16,
            "maxZoom": 19,
            "features": {
              "featureClasses": [
                "unit"
              ]
            }
          }
        }
      },
      "defaultMapConfigurationId": "{defaultMapConfigurationId}"
    },
    {
      "tilesetId": "{tilesetId}",
      "datasetId": "{datasetId}",
      "description": "My second tileset",
      "minZoom": 19,
      "maxZoom": 19,
      "bbox": [
        -122.13595,
        47.636524,
        -122.1329,
        47.637525
      ],
      "ontology": "facility-2.0",
      "tilesetConfiguration": {
        "version": 1,
        "layers": {
          "Indoor facility": {
            "minZoom": 13,
            "maxZoom": 20,
            "features": {
              "featureClasses": [
                "facility"
              ]
            }
          },
          "Indoor unit": {
            "minZoom": 16,
            "maxZoom": 19,
            "features": {
              "featureClasses": [
                "unit"
              ]
            }
          },
          "Indoor opening": {
            "minZoom": 16,
            "maxZoom": 19,
            "features": {
              "featureClasses": [
                "opening"
              ]
            }
          }
        }
      },
      "defaultMapConfigurationId": "{defaultMapConfigurationId}"
    }
  ]
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
Feature	Configurazione delle funzionalità per la configurazione del set di tessere.
LayerObject	Oggetto layer per la configurazione del set di tessere.
Tileset	Informazioni dettagliate per i dati.
TilesetConfiguration	Set di riquadri: campi di primo livello. Una configurazione del set di riquadri è un oggetto JSON che deve contenere i campi di primo livello seguenti:
TilesetListResult	Modello di risposta per l'API Elenco set di tessere. Restituisce un elenco di tutti i set di riquadri.

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.

Feature

Configurazione delle funzionalità per la configurazione del set di tessere.

Nome	Tipo	Descrizione
featureClasses	string[]	Elenco di classi di funzionalità che verranno usate per compilare il livello. Le classi di funzionalità valide sono disponibili nella definizione dell'ontologia. Ad esempio, l'ontologia della struttura
filter	object	Rimuove le funzionalità che non corrispondono a un criterio. Fare riferimento all'espressione di filtro MapLibre

LayerObject

Oggetto layer per la configurazione del set di tessere.

Nome	Tipo	Descrizione
features	Feature	Specifica le classi di funzionalità e i filtri.
maxZoom	integer	Livello di zoom più alto per il livello da compilare.
minZoom	integer	Livello di zoom più basso per il livello da compilare.

Tileset

Informazioni dettagliate per i dati.

Nome	Tipo	Descrizione
bbox	number[]	Rettangolo di selezione che tutte le caratteristiche del set di tessere 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 tessere.
defaultMapConfigurationId	string	ID di configurazione della mappa generato predefinito per il set di tessere
description	string	Descrizione fornita dal chiamante durante la creazione del set di tessere. Lunghezza massima di 1024 caratteri.
maxZoom	integer	Riquadro con il livello di zoom più alto generato per il set di tessere.
minZoom	integer	Riquadro con livello di zoom più basso generato per il set di tessere.
ontology	string	Versione ontologia di questo set di dati.
tilesetConfiguration	TilesetConfiguration	Configurazione del set di riquadri usata per compilare il set di tessere.
tilesetId	string	ID set di tessere univoco per il set di tessere.

TilesetConfiguration

Set di riquadri: campi di primo livello. Una configurazione del set di riquadri è un oggetto JSON che deve contenere i campi di primo livello seguenti:

Nome	Tipo	Descrizione
layers	<string, LayerObject>	Nomi dei livelli e delle relative opzioni di configurazione. L'oggetto layer di configurazione contiene coppie chiave-valore che associano i nomi dei livelli di riquadro alla relativa configurazione. Per ogni coppia chiave-valore, la chiave è il nome del livello e il valore è un LayerObject contenente la configurazione e le opzioni per il livello. Ogni livello deve avere un nome. Questo è l'identificatore univoco per il livello di dati nel set di tessere finale. In qualsiasi set di tessere ogni nome di livello deve essere univoco. Il nome del livello deve essere una stringa con solo caratteri di sottolineatura (_) e alfanumerici. L'oggetto LayerObject corrispondente per ogni nome di livello descrive la modalità di creazione del livello riquadro vettoriale. Specifica le classi di funzionalità per recuperare i dati delle funzionalità, la precisione dei dati tramite i livelli di zoom e come trasformare le funzionalità ed eseguirne il rendering in riquadri.
version	integer	Versione di Mappe di Azure riferimento alla configurazione del servizio Tiling usata dalla configurazione del set di riquadri. Attualmente è consentita solo la versione 1. L'uso di qualsiasi versione dell'altra versione corrente o di una versione precedente genererà un errore.

TilesetListResult

Modello di risposta per l'API Elenco set di tessere. Restituisce un elenco di tutti i set di riquadri.

Nome	Tipo	Descrizione
nextLink	string	Se presente, la posizione della pagina successiva dei dati.
tilesets	Tileset[]	Elenco di tutti i set di riquadri.

Condividi tramite