Render - Get Map Tile
Dient zum Anfordern von Kartenkacheln im Vektor- oder Rasterformat.
Die Get Map Tiles
-API in einer HTTP GET-Anforderung, mit der Benutzer Kartenkacheln in Vektor- oder Rasterformaten anfordern können, normalerweise in ein Kartensteuerelement oder SDK integriert werden. Einige Beispielkacheln, die angefordert werden können, sind Azure Maps-Straßenkacheln, Echtzeit-Wetterradar-Kacheln oder die Kartenkacheln, die mit Azure Maps Creator-erstellt wurden. Standardmäßig verwendet Azure Maps Vektorkacheln für das Webzuordnungssteuerelement (Web SDK-) und Android SDK-.
GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
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. Die aktuelle Version ist der 01.04.2024. |
tileset
|
query | True |
Ein Kachelset ist eine Sammlung von Raster- oder Vektordaten, die in ein einheitliches Raster von quadratischen Kacheln auf voreingestellten Zoomebenen unterteilt sind. Jedes Kachelset verfügt über eine tilesetId-, die beim Senden von Anforderungen verwendet werden soll. Die tilesetId- für Kacheln, die mit Azure Maps Creator- erstellt wurden, werden über die Kachelsatz-API-generiert. Die von Azure Maps bereitgestellten einsatzbereiten Kacheln 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, 2 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, 2 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. |
|
tile
|
query |
Die Größe der zurückgegebenen Kartenkachel in Pixeln. |
||
time
|
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.
|
|
view
|
query |
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 Parameter "View" in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen bezüglich der Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten und Inhalte von Drittanbietern, die Sie für den Zugriff über Azure Maps autorisiert haben, verfügbar 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 Verwendung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann über die Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Weitere Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie unter Verwalten der Authentifizierung in Azure Maps. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
object |
Die Kachel, die von einem erfolgreichen API-Aufruf zurückgegeben wird. 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. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen 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.
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 Karten-Verwaltungs-APIerworben werden.
Die Authorization URL
ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige 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 die konfigurationsbasierte Einrichtung 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 | 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 das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.
Mit diesem Schlüssel ist jede Anwendung berechtigt, auf alle REST-APIs zuzugreifen. 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 empfiehlt es sich, den Server-zu-Server-Zugriff von Azure Maps-REST-APIs zu verwenden, bei denen dieser 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 |
---|---|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
Error |
Das 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 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 Parameter "View" in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen bezüglich der Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten und Inhalte von Drittanbietern, die Sie für den Zugriff über Azure Maps autorisiert haben, verfügbar gemacht werden. Beispiel: view=IN. Weitere Informationen finden Sie unter Unterstützten Ansichten und die verfügbaren Ansichten. |
Map |
Die Größe der zurückgegebenen Kartenkachel in Pixeln. |
TilesetID |
Ein Kachelset ist eine Sammlung von Raster- oder Vektordaten, die in ein einheitliches Raster von quadratischen Kacheln auf voreingestellten Zoomebenen unterteilt sind. Jedes Kachelset verfügt über eine tilesetId-, die beim Senden von Anforderungen verwendet werden soll. Die tilesetId- für Kacheln, die mit Azure Maps Creator- erstellt wurden, werden über die Kachelsatz-API-generiert. Die von Azure Maps bereitgestellten einsatzbereiten Kacheln sind unten aufgeführt. Beispiel: microsoft.base. |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen. |
type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
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 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 Parameter "View" in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen bezüglich der Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten und Inhalte von Drittanbietern, die Sie für den Zugriff über Azure Maps autorisiert haben, verfügbar 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 von quadratischen Kacheln auf voreingestellten Zoomebenen unterteilt sind. Jedes Kachelset verfügt über eine tilesetId-, die beim Senden von Anforderungen verwendet werden soll. Die tilesetId- für Kacheln, die mit Azure Maps Creator- erstellt wurden, werden über die Kachelsatz-API-generiert. Die von Azure Maps bereitgestellten einsatzbereiten Kacheln 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 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 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 Abdeckung der Azure Maps-Wetterdienste. Weitere Informationen zu den zurückgegebenen Satellitendaten finden Sie unter Wetterdienste 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 |