Render - Get Map Tile

Dient zum Anfordern von Kartenkacheln im Vektor- oder Rasterformat.
Die Get Map Tiles API ermöglicht es Benutzern, Kartenkacheln im Vektor- oder Rasterformat anzufordern, in der Regel für die Integration in ein Kartensteuerelement oder SDK. Unterstützte Kacheltypen sind Azure Maps-Straßenkacheln und Echtzeit-Wetterradar-Kacheln. Standardmäßig verwendet das Azure Maps Web SDK Vektorkacheln zur Darstellung seiner Webkartensteuerung.

Important

Wenn Sie die Get Map Tile API verwenden, müssen Sie auch die Get Map Attribution API aufrufen, um den erforderlichen Kartendaten-Attributionstext abzurufen.

Die zurückgegebene Attribution muss überall dort angezeigt werden, wo Kacheln aus Get Map Tile gerendert werden, einschließlich in Drittanbieter-Kartensteuerungen oder benutzerdefinierten Rendering-Implementierungen.

GET {endpoint}/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET {endpoint}/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
endpoint
path True

string (uri)

Der Hostname des Azure Maps-Dienstes. Verwenden Sie https://atlas.microsoft.com für die Azure Public Cloud. Um eine bestimmte Azure Maps Geografie oder eine souveräne Cloud anzusprechen, siehe Azure Maps geografischer Umfang.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

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 soll. Die einsatzbereiten Tilesets von Azure Maps sind unten aufgeführt. Beispiel: microsoft.base.

x
query True

integer (int32)

X-Koordinate der Kachel im Zoomraster. Der Wert muss sich im Bereich [0, 2zoom -1] befinden.

Weitere Informationen finden Sie unter Zoomstufen und kachelraster-.

y
query True

integer (int32)

Y-Koordinate der Kachel im Zoomraster. Der Wert muss sich im Bereich [0, 2zoom -1] befinden.

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 eine der unterstützten IETF-Sprachtags sein, Groß-/Kleinschreibung wird nicht beachtet. 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ützten Sprachen.

tileSize
query

MapTileSize

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

timeStamp
query

string (date-time)

Das gewünschte Datum und die gewünschte Uhrzeit der angeforderten Kachel. Dieser Parameter muss im Standardmäßigen Datum-Uhrzeit-Format angegeben werden (z. B. 2019-11-14T16:03:00-08:00), wie durch ISO 8601definiert. Dieser Parameter wird nur unterstützt, wenn der "tilesetId"-Parameter auf einen der folgenden Werte festgelegt ist.

  • microsoft.weather.infrarot.main: Wir stellen Kacheln bis zu 3 Stunden in der Vergangenheit bereit. 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. Der TimeStamp-Wert wird auf den nächsten 5-Minuten-Zeitrahmen gerundet.
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 geopolitische umstrittene Regionen anzeigen. Unterschiedliche Länder/Regionen haben unterschiedliche Ansichten solcher Regionen, und der Parameter "View" ermöglicht Ihrer Anwendung die Einhaltung der vom Land/der Region benötigten Ansicht, die Ihre Anwendung bedient. Der Parameter "View" ist standardmäßig 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 Parameter "View" für diesen Speicherort korrekt festzulegen. Alternativ können Sie "View=Auto" festlegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgegeben werden. Der View-Parameter in Azure Maps muss gemäß den geltenden Gesetzen, einschließlich der Kartierung, des Landes/der Region verwendet werden, in der Karten, Bilder und andere Daten sowie Drittanbieter-Inhalte, auf die Sie über Azure Maps zugreifen dürfen, zugänglich gemacht werden. Beispiel: view=IN.

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

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-id

string

Gibt das Konto an, das für die Nutzung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann aus der Azure Maps Management-Plane-Konto-API abgerufen werden. Weitere Informationen zur Nutzung Microsoft Entra ID Sicherheit in Azure Maps finden Sie unter Authentifizierung verwalten in Azure Maps.

Antworten

Name Typ Beschreibung
200 OK

string

Die Anforderung ist erfolgreich.

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

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 Azure rollenbasierten Zugriffs Steuerung kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Azure-rollenbasierte Zugriffskontrollen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

Note

  • 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 Karten-Verwaltungs-APIerworben werden.
  • Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über einzigartige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen.
  • Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
  • Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.
  • Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.

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

Bereiche

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

subscription-key

Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

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

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch 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?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22

Beispiel für eine Antwort

Content-Type: application/vnd.mapbox-vector-tile
"binary image string"

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

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 geopolitische umstrittene Regionen anzeigen. Unterschiedliche Länder/Regionen haben unterschiedliche Ansichten solcher Regionen, und der Parameter "View" ermöglicht Ihrer Anwendung die Einhaltung der vom Land/der Region benötigten Ansicht, die Ihre Anwendung bedient. Der Parameter "View" ist standardmäßig 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 Parameter "View" für diesen Speicherort korrekt festzulegen. Alternativ können Sie "View=Auto" festlegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgegeben werden. Der View-Parameter in Azure Maps muss gemäß den geltenden Gesetzen, einschließlich der Kartierung, des Landes/der Region verwendet werden, in der Karten, Bilder und andere Daten sowie Drittanbieter-Inhalte, auf die Sie über Azure Maps zugreifen dürfen, zugänglich gemacht werden. Beispiel: view=IN.

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

MapTileSize

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

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 soll. Die einsatzbereiten Tilesets von Azure Maps sind unten aufgeführt. Beispiel: microsoft.base.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name Typ Beschreibung
error

ErrorDetail

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 geopolitische umstrittene Regionen anzeigen. Unterschiedliche Länder/Regionen haben unterschiedliche Ansichten solcher Regionen, und der Parameter "View" ermöglicht Ihrer Anwendung die Einhaltung der vom Land/der Region benötigten Ansicht, die Ihre Anwendung bedient. Der Parameter "View" ist standardmäßig 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 Parameter "View" für diesen Speicherort korrekt festzulegen. Alternativ können Sie "View=Auto" festlegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgegeben werden. Der View-Parameter in Azure Maps muss gemäß den geltenden Gesetzen, einschließlich der Kartierung, des Landes/der Region verwendet werden, in der Karten, Bilder und andere Daten sowie Drittanbieter-Inhalte, auf die Sie über Azure Maps zugreifen dürfen, zugänglich gemacht werden. Beispiel: view=IN.

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

Wert Beschreibung
AE

Vereinigte Arabische Emirate (arabische Ansicht)

AR

Argentinien (argentinische Ansicht)

BH

Bahrain (arabische Ansicht)

IN

Indien (indische Ansicht)

IQ

Irak (arabische Ansicht)

JO

Jordanien (arabische Ansicht)

KW

Kuwait (arabische Ansicht)

LB

Libanon (arabische Ansicht)

MA

Marokko (marokkanische Ansicht)

OM

Oman (arabische Ansicht)

PK

Pakistan (pakistanische Ansicht)

PS

Palästinensische Autonomiegebiete (arabische Ansicht)

QA

Katar (arabische Ansicht)

SA

Saudi-Arabien (arabische Ansicht)

SY

Syrien (arabische Ansicht)

US

Vereinigte Staaten von Amerika

YE

Jemen (arabische Ansicht)

Auto

Geben Sie die Kartendaten basierend auf der IP-Adresse der Anforderung zurück.

Unified

Einheitliche Ansicht (andere)

MapTileSize

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

Wert Beschreibung
256

Gibt eine Kachel mit 256 x 256 Pixeln zurück.

512

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 soll. Die einsatzbereiten Tilesets von Azure Maps sind unten aufgeführt. Beispiel: microsoft.base.

Wert Beschreibung
microsoft.base

Eine Basiskarte ist eine Standardkarte, die Straßen, natürliche und künstliche Features zusammen mit den Beschriftungen für diese Features in einer Vektorkachel anzeigt.

Unterstützt Zoomstufen 0 bis 22. Format: Vektor (Pbf).

microsoft.base.labels

Zeigt Beschriftungen für Straßen, natürliche und künstliche Merkmale in einer Vektorkachel an.

Unterstützt Zoomstufen 0 bis 22. Format: Vektor (Pbf).

microsoft.base.hybrid

Zeigt Straßen-, Begrenzungs- und Beschriftungsdaten in einer Vektorkachel an.

Unterstützt Zoomstufen 0 bis 22. Format: Vektor (Pbf).

microsoft.terra.main

Schattierte Relief- und Terraschichten.

Unterstützt Zoomstufen 0 bis 6. Format: Raster (png).

microsoft.base.road

Alle Ebenen mit unserem Hauptstil.

Unterstützt Zoomstufen 0 bis 22. Format: Raster (png).

microsoft.base.darkgrey

Alle Ebenen mit unserem dunkelgrauen Stil.

Unterstützt Zoomstufen 0 bis 22. Format: Raster (png).

microsoft.base.labels.road

Beschriftungsdaten in unserem Hauptstil.

Unterstützt Zoomstufen 0 bis 22. Format: Raster (png).

microsoft.base.labels.darkgrey

Beschriftungsdaten in unserer dunkelgrauen Formatvorlage.

Unterstützt Zoomstufen 0 bis 22. Format: Raster (png).

microsoft.base.hybrid.road

Straßen-, Begrenzungs- und Beschriftungsdaten in unserem Hauptstil.

Unterstützt Zoomstufen 0 bis 22. Format: Raster (png).

microsoft.base.hybrid.darkgrey

Straßen-, Begrenzungs- und Beschriftungsdaten in unserem dunkelgrauen Stil.

Unterstützt Zoomstufen 0 bis 22. Format: Raster (png).

microsoft.imagery

Eine Kombination aus Satelliten- oder Luftbildbildern. Nur in S1- und G2-Preis-SKU verfügbar.

Unterstützt Zoomstufen 1 bis 19. Format: Raster (png).

microsoft.weather.radar.main

Wetterradarkacheln. Aktuelle Wetterradarbilder wie Regen-, Schnee-, Eis- und Mischbedingungen. Weitere Informationen zur Berichterstattung des Azure Maps Weather Service finden Sie unter Azure Maps Weather Services Coverage. Weitere Informationen zu Radardaten finden Sie unter Weather Services in Azure Maps.

Unterstützt Zoomstufen 0 bis 15. Format: Raster (png).

microsoft.weather.infrared.main

Wetter-Infrarot-Kacheln. Neueste Infrarotsatellitenbilder zeigen Wolken nach ihrer Temperatur. Weitere Informationen finden Sie unter Azure Maps Wetterdienstberichten. Weitere Informationen zu den zurückgegebenen Satellitendaten finden Sie unter Weather Services in Azure Maps.

Unterstützt Zoomstufen 0 bis 15. Format: Raster (png).

microsoft.traffic.absolute

absolute Datenverkehrskacheln im Vektor

microsoft.traffic.absolute.main

absolute Verkehrskacheln im Raster in unserem Hauptstil.

microsoft.traffic.relative

Relative Datenverkehrskacheln im Vektor

microsoft.traffic.relative.main

Relative Datenverkehrskacheln im Raster in unserem Hauptstil.

microsoft.traffic.relative.dark

Relative Datenverkehrskacheln im Raster in unserem dunklen Stil.

microsoft.traffic.delay

Datenverkehrskacheln im Vektor

microsoft.traffic.delay.main

Verkehrskacheln im Raster in unserem Hauptstil

microsoft.traffic.reduced.main

Reduzierte Verkehrskacheln im Raster im Hauptstil

microsoft.traffic.incident

Vorfallkacheln im Vektor