Render - Get Map Tile

Dienst:

Maps

API-Version:

2024-04-01

Verwenden Sie , um Kartenkacheln im Vektor- oder Rasterformat anzufordern.

Die Get Map Tiles API in einer HTTP GET-Anforderung, mit der Benutzer Kartenkacheln in Vektor- oder Rasterformaten in der Regel in ein Kartensteuerelement oder SDK integrieren können. Einige Beispielkacheln, die angefordert werden können, sind Azure Maps-Straßenkacheln, Echtzeit-Wetterradarkacheln oder die Kartenkacheln, die mit Azure Maps Creator erstellt wurden. Standardmäßig verwendet Azure Maps Vektorkacheln für das Web map control (Web SDK) und das Android SDK.

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}

Mit optionalen Parametern:

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Versionsnummer der Azure Maps API. Aktuelle Version ist 2024-04-01.
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 Kachelsatz-ID , die beim Senden von Anforderungen verwendet werden kann. Die TilesetId für Kachelsets, die mit Azure Maps Creator erstellt wurden, werden über die Kachelseterstellungs-API generiert. Die von Azure Maps bereitgestellten einsatzbereiten Kachelsets sind unten aufgeführt. Beispiel: microsoft.base.
x	query	True	integer int32	X-Koordinate der Kachel im Zoomraster. Der Wert muss im Bereich [0, 2zoom -1] liegen. Weitere Informationen finden Sie unter Zoomstufen und Kachelraster .
y	query	True	integer int32	Y-Koordinate der Kachel im Zoomraster. Der Wert muss im Bereich [0, 2zoom -1] liegen. Weitere Informationen finden Sie unter Zoomstufen und Kachelraster .
zoom	query	True	integer int32	Zoomfaktor für die gewünschte Kachel. Weitere Informationen finden Sie unter Zoomstufen und Kachelraster .
language	query		string	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache verwendet. Weitere Informationen finden Sie unter Unterstützte Sprachen .
tileSize	query		MapTileSize	Die Größe der zurückgegebenen Kartenkachel in Pixel.
timeStamp	query		string date-time	Das gewünschte Datum und die gewünschte Uhrzeit der angeforderten Kachel. Dieser Parameter muss im standardmäßigen Datums-/Uhrzeitformat (z. B. 2019-11-14T16:03:00-08:00) gemäß ISO 8601 angegeben werden. Dieser Parameter wird nur unterstützt, wenn der TilesetId-Parameter auf einen der folgenden Werte festgelegt ist. microsoft.weather.infrared.main: Wir bieten Kacheln bis zu 3 Stunden in der Vergangenheit an. Kacheln sind in 10-Minuten-Intervallen verfügbar. Wir runden den timeStamp-Wert auf den nächsten 10-Minuten-Zeitrahmen. microsoft.weather.radar.main: Wir bieten Kacheln bis zu 1,5 Stunden in der Vergangenheit und bis zu 2 Stunden in der Zukunft an. Kacheln sind in 5-Minuten-Intervallen verfügbar. Wir runden den timeStamp-Wert auf den nächsten 5-Minuten-Zeitrahmen.
view	query		LocalizedMapView	Mit dem Parameter View (auch als Parameter "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitisch umstrittene Regionen anzeigen. Unterschiedliche Länder/Regionen haben unterschiedliche Ansichten dieser Regionen, und der Parameter View ermöglicht es Ihrer Anwendung, die für das Land/die Region, das/die/die Ihre Anwendung bereitstellen wird, erforderlich zu erfüllen. Standardmäßig ist der View-Parameter auf "Unified" festgelegt, auch wenn Sie ihn in der Anforderung nicht definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den „View“-Parameter für diesen Standort entsprechend festzulegen. Alternativ haben Sie die Möglichkeit, „View=Auto“ festzulegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgibt. Der View-Parameter in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen zur Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten sowie Inhalte von Drittanbietern, auf die Sie über Azure Maps zugreifen dürfen, verfügbar gemacht werden. Beispiel: view=IN. Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .

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. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln .

Antworten

Name	Typ	Beschreibung
200 OK	object	Die Kachel, die von einem erfolgreichen API-Aufruf zurückgegeben wurde. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Header Content-Type: string
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung von Azure 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-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem 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.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

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.

Ist Authorization URL spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die 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 Übersicht über Microsoft Identity Platform.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die 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 Hauptschlü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.

Typ: apiKey
In: header

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem SAS-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Successful Tile Request

Beispielanforderung

HTTP

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22

Beispiel für eine Antwort

Statuscode:

200

Content-Type: application/vnd.mapbox-vector-tile

"binary image string"

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
LocalizedMapView	Mit dem Parameter View (auch als "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitisch umstrittene Regionen anzeigen. Verschiedene Länder/Regionen haben unterschiedliche Ansichten zu diesen Regionen, und der View-Parameter ermöglicht es Ihrer Anwendung, die Ansicht zu erfüllen, die für das Land/die Region erforderlich ist, in dem/der Ihre Anwendung verwendet wird. Standardmäßig ist der View-Parameter auf "Unified" festgelegt, auch wenn Sie ihn nicht in der Anforderung definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den „View“-Parameter für diesen Standort entsprechend festzulegen. Alternativ haben Sie die Möglichkeit, „View=Auto“ festzulegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgibt. Der View-Parameter in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derer in Bezug auf die Zuordnung, des Landes/der Region, in dem Karten, Bilder und andere Daten sowie Inhalte von Drittanbietern verfügbar gemacht werden, auf die Sie über Azure Maps zugreifen dürfen. Beispiel: view=IN. Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .
MapTileSize	Die Größe der zurückgegebenen Kartenkachel in Pixel.
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.

LocalizedMapView

Mit dem Parameter View (auch als "Benutzerregion" bezeichnet) können Sie die richtigen Karten für ein bestimmtes Land/eine bestimmte Region für geopolitisch umstrittene Regionen anzeigen. Verschiedene Länder/Regionen haben unterschiedliche Ansichten zu diesen Regionen, und der View-Parameter ermöglicht es Ihrer Anwendung, die Ansicht zu erfüllen, die für das Land/die Region erforderlich ist, in dem/der Ihre Anwendung verwendet wird. Standardmäßig ist der View-Parameter auf "Unified" festgelegt, auch wenn Sie ihn nicht in der Anforderung definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den „View“-Parameter für diesen Standort entsprechend festzulegen. Alternativ haben Sie die Möglichkeit, „View=Auto“ festzulegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgibt. Der View-Parameter in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derer in Bezug auf die Zuordnung, des Landes/der Region, in dem Karten, Bilder und andere Daten sowie Inhalte von Drittanbietern verfügbar gemacht werden, auf die Sie über Azure Maps zugreifen dürfen. Beispiel: view=IN.

Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .

Name	Typ	Beschreibung
AE	string	Vereinigte Arabische Emirate (arabische Ansicht)
AR	string	Argentinien (argentinische Ansicht)
Auto	string	Gibt die Kartendaten basierend auf der IP-Adresse der Anforderung zurück.
BH	string	Bahrain (arabische Ansicht)
IN	string	Indien (indische Ansicht)
IQ	string	Irak (arabische Ansicht)
JO	string	Jordanien (arabische Ansicht)
KW	string	Kuwait (arabische Ansicht)
LB	string	Libanon (arabische Ansicht)
MA	string	Marokko (marokkanische Ansicht)
OM	string	Oman (arabische Ansicht)
PK	string	Pakistan (pakistanische Ansicht)
PS	string	Palästinensische Autonomiegebiete (arabische Ansicht)
QA	string	Katar (arabische Ansicht)
SA	string	Saudi-Arabien (arabische Ansicht)
SY	string	Syrien (arabische Ansicht)
Unified	string	Einheitliche Ansicht (andere)
YE	string	Jemen (arabische Ansicht)

MapTileSize

Die Größe der zurückgegebenen Kartenkachel in Pixel.

Name	Typ	Beschreibung
256	string	Gibt eine Kachel mit 256 x 256 Pixeln zurück.
512	string	Gibt eine Kachel mit 512 x 512 Pixeln zurück.

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 Hauptstil. 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 in unserem Hauptformat. Unterstützt die Zoomstufen 0 bis 22. Format: raster (png).
microsoft.base.road	string	Alle Ebenen mit unserem Hauptstil. 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 Hauptstil.
microsoft.traffic.delay	string	Verkehrskacheln im Vektor
microsoft.traffic.delay.main	string	Verkehrskacheln im Raster in unserem Hauptstil
microsoft.traffic.incident	string	Incidentkacheln im Vektor
microsoft.traffic.reduced.main	string	Reduzierte Verkehrskacheln im Raster in unserem Hauptstil
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 Hauptstil.
microsoft.weather.infrared.main	string	Wetter-Infrarotkacheln. Neueste Infrarotsatellitenbilder zeigen Wolken anhand ihrer Temperatur. Weitere Informationen finden Sie unter Abdeckung von Azure Maps-Wetterdiensten. Weitere Informationen zu den zurückgegebenen Satellitendaten finden Sie unter Wetterdienste in Azure Maps. Unterstützt die Zoomstufen 0 bis 15. Format: raster (png).
microsoft.weather.radar.main	string	Wetterradarkacheln. Aktuelle Wetterradarbilder mit Regen-, Schnee-, Eis- und Mischbedingungen. Weitere Informationen zur Abdeckung des Azure Maps-Wetterdiensts finden Sie unter Abdeckung der Azure Maps-Wetterdienste. Weitere Informationen zu Radardaten finden Sie unter Wetterdienste in Azure Maps. Unterstützt die Zoomstufen 0 bis 15. Format: raster (png).