Tileset - Get

Referenz

Service:: Maps Creator

API Version:: 2023-03-01-preview

Verwenden Sie, um die Details eines Kachelsets abzurufen.

Übermitteln von Get Request

Die Get API ist eine HTTP-Anforderung GET , die zum Abrufen der Details eines Tilesets verwendet wird.

GET https://{geography}.atlas.microsoft.com/tilesets/{tilesetId}?api-version=2023-03-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
geography	path	True	string	Dieser Parameter gibt an, wo sich die Azure Maps Creator-Ressource befindet. Gültige Werte sind wir und eu.
tilesetId	path	True	string	Die Kachelset-ID
api-version	query	True	string	Versionsnummer der Azure Maps API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	Tileset	Die Anforderung des Listenkachels wurde erfolgreich abgeschlossen. Der Antworttext enthält eine Liste aller Kachelsätze.
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweise

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Work, School und Guests, aber keine persönlichen Konten.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam genutzter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, CLI, Azure SDKs oder REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

Gets the details for a single tileset

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "tilesetId": "{tilesetId}",
  "datasetId": "{datasetId}",
  "description": "My first tileset",
  "minZoom": 16,
  "maxZoom": 18,
  "bbox": [
    -122.13595,
    47.636524,
    -122.1329,
    47.637525
  ]
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
Feature	Featurekonfiguration für die Kachelsatzkonfiguration.
LayerObject	Ebenenobjekt für die Kachelsatzkonfiguration.
Tileset	Detailinformationen für die Daten.
TilesetConfiguration	Kachelsetkonfigurationsfelder auf oberster Ebene. Eine Kacheletkonfiguration ist ein JSON-Objekt, das die folgenden Felder der obersten Ebene enthalten muss:

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Feature

Featurekonfiguration für die Kachelsatzkonfiguration.

Name	Typ	Beschreibung
featureClasses	string[]	Die Liste der Featureklassen, die zum Erstellen der Ebene verwendet werden. Die gültigen Featureklassen finden Sie in der Ontologiedefinition. Beispiel : Facility Ontology
filter	object	Entfernt Features, die keinem Muster entsprechen. Weitere Informationen finden Sie unter MapLibre-Filterausdruck.

LayerObject

Ebenenobjekt für die Kachelsatzkonfiguration.

Name	Typ	Beschreibung
features	Feature	Gibt die Featureklassen und Filter an.
maxZoom	integer	Die höchste Zoomstufe für die zu erstellende Ebene.
minZoom	integer	Die niedrigste Zoomstufe für die zu erstellende Ebene.

Tileset

Detailinformationen für die Daten.

Name	Typ	Beschreibung
bbox	number[]	Begrenzungsrahmen, in dem alle Features des Kachelsets enthalten sind. Verwendete Projektion – EPSG:3857. Format: 'minLon, minLat, maxLon, maxLat'.
datasetId	string	Die eindeutige Dataset-ID, die zum Erstellen des Kachelsets verwendet wird.
defaultMapConfigurationId	string	Die standardmäßig generierte Kartenkonfigurations-ID für das Kachelset
description	string	Die Beschreibung, die der Aufrufer beim Erstellen des Kachelsets angegeben hat. Maximale Länge von 1024 Zeichen.
maxZoom	integer	Die Kachel mit der höchsten Kachelzoomebene, die für das Kachelset generiert wurde.
minZoom	integer	Die Kachel mit der niedrigsten Kachelzoomebene, die für das Kachelset generiert wurde.
ontology	string	Die Ontologieversion dieses Datasets.
tilesetConfiguration	TilesetConfiguration	Kachelsetkonfiguration, die zum Erstellen des Kachelsatzes verwendet wird.
tilesetId	string	Die eindeutige Kachelsatz-ID für das Kachelset.

TilesetConfiguration

Kachelsetkonfigurationsfelder auf oberster Ebene. Eine Kacheletkonfiguration ist ein JSON-Objekt, das die folgenden Felder der obersten Ebene enthalten muss:

Name	Typ	Beschreibung
layers	<string, LayerObject>	Die Namen der Ebenen und ihre Konfigurationsoptionen. Das Konfigurationsebenenobjekt enthält Schlüssel-Wert-Paare, die die Namen der Kachelebenen ihrer Konfiguration zuordnen. Für jedes Schlüssel-Wert-Paar ist der Schlüssel der Name der Ebene, und der Wert ist ein LayerObject, das die Konfiguration und die Optionen für die Ebene enthält. Jede Ebene muss einen Namen haben. Dies ist der eindeutige Bezeichner für die Datenebene in Ihrem letzten Kachelset. In jedem Kachelset muss jeder Ebenenname eindeutig sein. Der Ebenenname muss eine Zeichenfolge mit nur Unterstrichen (_) und alphanumerischen Zeichen sein. Das entsprechende LayerObject für jeden Ebenennamen beschreibt, wie diese Vektorkachelebene erstellt werden soll. Es gibt an, welche Featureklassen Featuredaten abgerufen werden sollen, die Genauigkeit der Daten über Zoomstufen und wie Features transformiert und in Kacheln gerendert werden sollen.
version	integer	Die Version von Azure Maps Kacheldienstkonfigurationsreferenz, die von der Kacheletkonfiguration verwendet wird. Derzeit ist nur Version 1 zulässig. Die Verwendung einer anderen Version der aktuellen oder früheren Version führt zu einem Fehler.