Render - Get Map Tile
verwenden, um Kartenkacheln im Vektor- oder Rasterformat abzurufen, die in der Regel in ein neues Kartensteuerelement oder SDK integriert werden.
Hinweis
Azure Maps Render v1-Dienst eingestellt
Der Azure Maps Render v1 Dienst ist jetzt veraltet und wird am 17.09.2026 eingestellt. Um Dienstunterbrechungen zu vermeiden, müssen alle Aufrufe der Render v1-API bis zum 17.09.26 aktualisiert werden, um die Render v2-API zu verwenden.
Ruft Kartenkacheln im Vektor- oder Rasterformat ab, um in einem neuen Kartensteuerelement oder SDK integriert zu werden. Standardmäßig verwendet Azure Vektorkartenkacheln für das Webkartensteuerelement (siehe Zoomstufen und Kachelraster).
Hinweis: Wetterkacheln sind nur über die API zum Abrufen von Kartenkacheln V2 verfügbar. Es wird empfohlen, mit der Verwendung der neuen GET Map Tile V2-API zu beginnen.
GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}&tileSize={tileSize}&language={language}&view={view}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
format
|
path | True |
Das gewünschte Format der Antwort. Mögliche Werte sind png & pbf. |
|
api-version
|
query | True |
string |
Versionsnummer der Azure Maps API. |
layer
|
query | True |
Kartenebene angefordert. Mögliche Werte sind basic, hybrid, labels und terra. |
|
style
|
query | True |
Zurückzugebende Kartenformat Mögliche Werte sind Standard, dunkel und shaded_relief. |
|
x
|
query | True |
integer int32 |
X-Koordinate der Kachel im Zoomraster. Der Wert muss im Bereich [0, 2 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, 2 Weitere Informationen finden Sie unter Zoomstufen und Kachelraster . |
zoom
|
query | True |
integer int32 |
Zoomstufe 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 . |
|
tile
|
query |
Die Größe der zurückgegebenen Kartenkachel in Pixel. |
||
view
|
query |
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 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 in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell verwendet werden soll. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Azure Maps-Verwaltungsebenen-API abgerufen werden. Informationen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
object |
Dieses Bild wird von einem erfolgreichen Aufruf der Get Map-Kachel zurückgegeben. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Header Content-Type: string |
Other Status Codes |
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 in 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 Ressourcenkonto 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-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen.
* Die rollenbasierte Zugriffssteuerung von 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.
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 eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API bereitgestellt wird.
Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: 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 für den Zugriff auf Azure Maps REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
query
SAS Token
Dies ist 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 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
GET https://atlas.microsoft.com/map/tile/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22
Beispiel für eine Antwort
Content-Type: image/png
"{file}"
Definitionen
Name | Beschreibung |
---|---|
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Localized |
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 . |
Map |
Kartenebene angefordert. Mögliche Werte sind basic, hybrid, labels und terra. |
Map |
Die Größe der zurückgegebenen Kartenkachel in Pixel. |
Map |
Zurückzugebende Kartenformatvorlage. Mögliche Werte sind Standard, dunkel und shaded_relief. |
Tile |
Das gewünschte Format der Antwort. Mögliche Werte sind png & pbf. |
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 |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
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 .
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) |
MapTileLayer
Kartenebene angefordert. Mögliche Werte sind basic, hybrid, labels und terra.
Name | Typ | Beschreibung |
---|---|---|
basic |
string |
Gibt eine Kachel zurück, die alle Kartenfeatures einschließlich Polygone, Rahmen, Straßen und Bezeichnungen enthält. |
hybrid |
string |
Gibt eine Kachel mit Rahmen, Straßen und Bezeichnungen zurück und kann auf anderen Kacheln (z. B. Satellitenbildern) überlagert werden, um Hybridkacheln zu erzeugen. |
labels |
string |
Gibt eine Kachel mit nur den Bezeichnungsinformationen der Karte zurück. |
terra |
string |
Map Canvas komplett mit schattierten Reliefkacheln. Zoomstufen 0 bis 6 (inklusive) werden unterstützt. Png ist das einzige unterstützte TileFormat, und nur MapTileSize ist 512 verfügbar. |
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. |
MapTileStyle
Zurückzugebende Kartenformatvorlage. Mögliche Werte sind Standard, dunkel und shaded_relief.
Name | Typ | Beschreibung |
---|---|---|
dark |
string |
Dunkelgraue Version des Azure Maps Standard Stils. PNG ist das einzige unterstützte TileFormat. |
main |
string |
Azure Maps Standard Stil |
shaded_relief |
string |
Azure Maps Standard Stil mit schattiertem Relief ergänzt. Unterstützt von Layer terra. |
TileFormat
Das gewünschte Format der Antwort. Mögliche Werte sind png & pbf.
Name | Typ | Beschreibung |
---|---|---|
pbf |
string |
Vektorgrafik im pbf-Format. Unterstützt Zoomstufen 0 bis 22. |
png |
string |
Ein Bild im PNG-Format. Unterstützt Zoomstufen 0 bis 18. |