Render - Get Map Tileset

Referenz

Service:: Maps

API Version:: 2022-08-01

Verwenden Sie, um Metadaten für ein Kachelset abzurufen.
**

Die Get Map Tileset API ist eine HTTP-Anforderung GET , mit der Benutzer Metadaten für ein Kachelset anfordern können.

GET https://atlas.microsoft.com/map/tileset?api-version=2022-08-01&tilesetId={tilesetId}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Versionsnummer der Azure Maps API. Aktuelle Version ist 01.08.2022
tilesetId	query	True	TilesetID	Ein Kachelset ist eine Sammlung von Raster- oder Vektordaten, die in ein einheitliches Raster aus quadratischen Kacheln mit voreingestellten Zoomstufen zerlegt werden. Jedes Kachelset verfügt über eine tilesetId , die beim Senden von Anforderungen verwendet werden kann. Die TilesetId für Kachelsätze, die mit Azure Maps Creator erstellt wurden, werden über die Tileset-Create-API generiert. Die von Azure Maps bereitgestellten einsatzbereiten Kachelsätze sind unten aufgeführt. Beispiel: microsoft.base.

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	MapTileset	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 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 Microsoft Entra ID 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.

Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

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 beim Erstellen einer Azure Maps Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung für den Zugriff auf alle REST-APIs autorisiert. Mit anderen Worten, diese können derzeit als master Schlüssel für das Konto behandelt werden, für das sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Server-zu-Server-Zugriff auf Azure Maps REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: header

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

Successful Tileset Request

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "tilejson": "2.2.0",
  "name": "microsoft.core.vector",
  "version": "1.0.0",
  "attribution": "<a data-azure-maps-attribution-dynamic=\"true\" data-azure-maps-attribution-tileset=\"microsoft.core.vector\"></a>",
  "scheme": "xyz",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2.1&tilesetId=microsoft.core.vector&zoom={z}&x={x}&y={y}&language=ngt"
  ],
  "grids": [],
  "data": [],
  "minzoom": 1,
  "maxzoom": 21,
  "bounds": [
    -180,
    -90,
    180,
    90
  ]
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
MapTileset	Metadaten für ein Kachelset im TileJSON-Format.
TilesetID	Ein Kachelset ist eine Sammlung von Raster- oder Vektordaten, die in ein einheitliches Raster aus quadratischen Kacheln mit voreingestellten Zoomstufen zerlegt werden. Jedes Kachelset verfügt über eine tilesetId , die beim Senden von Anforderungen verwendet werden kann. Die TilesetId für Kachelsätze, die mit Azure Maps Creator erstellt wurden, werden über die Tileset-Create-API generiert. Die von Azure Maps bereitgestellten einsatzbereiten Kachelsätze sind unten aufgeführt. Beispiel: microsoft.base.

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.

MapTileset

Metadaten für ein Kachelset im TileJSON-Format.

Name	Typ	Beschreibung
attribution	string	Copyright-Namensnennung, die auf der Karte angezeigt werden soll. Implementierungen KÖNNEN sich entscheiden, dies als HTML- oder Literaltext zu behandeln. Stellen Sie aus Sicherheitsgründen unbedingt sicher, dass dieses Feld nicht als Vektor für XSS oder beacon Tracking missbraucht werden kann.
bounds	number[]	Die maximale Ausdehnung der verfügbaren Kartenkacheln. Grenzen MÜSSEN einen Bereich definieren, der von allen Zoomstufen abgedeckt wird. Die Grenzen werden in WGS:84 Breiten- und Längengradwerten in der Reihenfolge links, unten, rechts, oben dargestellt. Werte können ganze Zahlen oder Gleitkommazahlen sein.
center	number[]	Die Standardposition des Kachelsets im Format [Längengrad, Breitengrad, Zoom]. Die Zoomstufe MUSS zwischen minzoom und maxzoom liegen. Implementierungen können diesen Wert verwenden, um den Standardspeicherort festzulegen.
data	string[]	Ein Array von Datendateien im GeoJSON-Format.
description	string	Textbeschreibung des Kachelsets. Die Beschreibung kann ein beliebiges Rechtszeichen enthalten. Implementierungen SOLLTEN die Beschreibung NICHT als HTML interpretieren.
grids	string[]	Ein Array von Interaktivitätsendpunkten.
legend	string	Eine Legende, die mit der Karte angezeigt werden soll. Implementierungen KÖNNEN sich entscheiden, dies als HTML- oder Literaltext zu behandeln. Stellen Sie aus Sicherheitsgründen unbedingt sicher, dass dieses Feld nicht als Vektor für XSS oder beacon Tracking missbraucht werden kann.
maxzoom	integer	Die maximale Zoomstufe.
minzoom	integer	Die minimale Zoomstufe.
name	string	Ein Name, der das Kachelset beschreibt. Der Name kann ein beliebiges rechtliches Zeichen enthalten. Implementierungen SOLLTEN den Namen NICHT als HTML interpretieren.
scheme	string	Standardwert: "xyz". Entweder "xyz" oder "tms". Beeinflusst die y-Richtung der Kachelkoordinaten. Das Global-mercator-Profil (auch Spherical Mercator genannt) wird angenommen.
template	string	Eine Schnurartvorlage, die zum Formatieren von Daten aus Rastern für die Interaktion verwendet werden soll.
tilejson	string	Beschreibt die Version der TileJSON-Spezifikation, die von diesem JSON-Objekt implementiert wird.
tiles	string[]	Ein Array von Kachelendpunkten. Wenn mehrere Endpunkte angegeben werden, können Clients eine beliebige Kombination von Endpunkten verwenden. Alle Endpunkte MÜSSEN denselben Inhalt für dieselbe URL zurückgeben. Das Array MUSS mindestens einen Endpunkt enthalten.
version	string	Eine semver.org Formatversionsnummer für die Kacheln, die im Kachelset enthalten sind. Wenn Kacheländerungen eingeführt werden, MUSS sich die Nebenversion ändern.

TilesetID

Ein Kachelset ist eine Sammlung von Raster- oder Vektordaten, die in ein einheitliches Raster aus quadratischen Kacheln mit voreingestellten Zoomstufen zerlegt werden. Jedes Kachelset verfügt über eine tilesetId , die beim Senden von Anforderungen verwendet werden kann. Die TilesetId für Kachelsätze, die mit Azure Maps Creator erstellt wurden, werden über die Tileset-Create-API generiert. Die von Azure Maps bereitgestellten einsatzbereiten Kachelsätze sind unten aufgeführt. Beispiel: microsoft.base.

Name	Typ	Beschreibung
microsoft.base	string	Eine Basiskarte ist eine Standardkarte, die Straßen, natürliche und künstliche Features zusammen mit den Bezeichnungen für diese Features in einer Vektorkachel anzeigt. Unterstützt die Zoomstufen 0 bis 22. Format: Vektor (pbf).
microsoft.base.darkgrey	string	Alle Schichten mit unserem dunkelgrauen Stil. Unterstützt die Zoomstufen 0 bis 22. Format: raster (png).
microsoft.base.hybrid	string	Zeigt Straßen-, Begrenzungs- und Beschriftungsdaten in einer Vektorkachel an. Unterstützt die Zoomstufen 0 bis 22. Format: Vektor (pbf).
microsoft.base.hybrid.darkgrey	string	Straßen-, Begrenzungs- und Beschriftungsdaten in unserem dunkelgrauen Stil. Unterstützt die Zoomstufen 0 bis 22. Format: raster (png).
microsoft.base.hybrid.road	string	Straßen-, Begrenzungs- und Beschriftungsdaten in unserem Standard Stil. Unterstützt die Zoomstufen 0 bis 22. Format: raster (png).
microsoft.base.labels	string	Zeigt Bezeichnungen für Straßen, natürliche und künstliche Merkmale in einer Vektorkachel an. Unterstützt die Zoomstufen 0 bis 22. Format: Vektor (pbf).
microsoft.base.labels.darkgrey	string	Bezeichnen Sie Daten im dunkelgrauen Stil. Unterstützt die Zoomstufen 0 bis 22. Format: raster (png).
microsoft.base.labels.road	string	Bezeichnen Sie Daten im Standard Stil. Unterstützt die Zoomstufen 0 bis 22. Format: raster (png).
microsoft.base.road	string	Alle Ebenen mit unserem Standard Stil. Unterstützt die Zoomstufen 0 bis 22. Format: raster (png).
microsoft.imagery	string	Eine Kombination aus Satelliten- und Luftbildern. Nur in der S1-Preis-SKU verfügbar. Unterstützt die Zoomstufen 1 bis 19. Format: raster (jpeg).
microsoft.terra.main	string	Schattierte Relief- und Terra-Schichten. Unterstützt die Zoomstufen 0 bis 6. Format: raster (png).
microsoft.traffic.absolute	string	absolute Verkehrskacheln im Vektor
microsoft.traffic.absolute.main	string	absolute Verkehrskacheln im Raster in unserem Standard Stil.
microsoft.traffic.delay	string	Verkehrskacheln im Vektor
microsoft.traffic.delay.main	string	Verkehrskacheln im Raster im Standard-Stil
microsoft.traffic.incident	string	Incidentkacheln im Vektor
microsoft.traffic.reduced.main	string	Weniger Verkehrskacheln im Raster in unserem Standard Stil
microsoft.traffic.relative	string	relative Verkehrskacheln im Vektor
microsoft.traffic.relative.dark	string	relative Verkehrskacheln im Raster in unserem dunklen Stil.
microsoft.traffic.relative.main	string	relative Verkehrskacheln im Raster in unserem Standard Stil.
microsoft.weather.infrared.main	string	Wetter-Infrarotkacheln. Neueste Infrarotsatellitenbilder zeigen Wolken anhand ihrer Temperatur. Siehe Abdeckungsinformationen für Azure Maps Wetterdienst. Weitere Informationen zu den zurückgegebenen Satellitendaten finden Sie unter Wetterkonzepte. Unterstützt die Zoomstufen 0 bis 15. Format: raster (png).
microsoft.weather.radar.main	string	Wetterradarkacheln. Aktuelle Wetterradarbilder mit Regen-, Schnee-, Eis- und Mischbedingungen. Siehe Abdeckungsinformationen für Azure Maps Wetterdienst. Weitere Informationen zu den Radardaten finden Sie unter Wetterkonzepte. Unterstützt die Zoomstufen 0 bis 15. Format: raster (png).