Render - Get Map Tile
wird verwendet, um Kartenkacheln im Vektor- oder Rasterformat abzurufen, die normalerweise in ein neues Kartensteuerelement oder SDK integriert werden.
Hinweis
Einstellung des Azure Maps-Renderingdiensts v1
Der Azure Maps Render v1-Dienst ist jetzt veraltet und wird am 17.09.26. eingestellt. Um Dienstunterbrechungen zu vermeiden, müssen alle Aufrufe der Render v1-API aktualisiert werden, um die neueste Version der Render-API bis zum 17.09.26 zu verwenden.
Ruft Kartenkacheln im Vektor- oder Rasterformat ab, die normalerweise in ein neues Kartensteuerelement oder SDK integriert werden sollen. Standardmäßig verwendet Azure Vektorkartenkacheln für das Webkartensteuerelement (siehe Zoomstufen und Kachelraster)
Hinweis: Wetterkacheln sind mit der Get Map Tile v1.0-API nicht verfügbar. Es wird empfohlen, die neueste Version der Get Map Tile API zu verwenden.
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 |
Gewünschtes 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 einfach, hybrid, bezeichnungen und terra. |
|
|
style
|
query | True |
Die zurückgegebene Kartenformatvorlage. Mögliche Werte sind Haupt-, Dunkel- und shaded_relief. |
|
|
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. |
||
|
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 |
Dieses Bild wird von einem erfolgreichen Aufruf der Kachel "Karte abrufen" 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. 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 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:
query
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/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 |
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 |
Kartenebene angefordert. Mögliche Werte sind einfach, hybrid, bezeichnungen und terra. |
|
Map |
Die Größe der zurückgegebenen Kartenkachel in Pixeln. |
|
Map |
Die zurückgegebene Kartenformatvorlage. Mögliche Werte sind Haupt-, Dunkel- und shaded_relief. |
|
Tile |
Gewünschtes Format der Antwort. Mögliche Werte sind png & Pbf. |
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 (indischer Blick) |
| 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 Behörde (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) |
MapTileLayer
Kartenebene angefordert. Mögliche Werte sind einfach, hybrid, bezeichnungen und terra.
| Wert | Beschreibung |
|---|---|
| basic |
Gibt eine Kachel zurück, die alle Kartenfeatures wie Polygone, Rahmen, Straßen und Beschriftungen enthält. |
| hybrid |
Gibt eine Kachel zurück, die Rahmen, Straßen und Beschriftungen enthält und auf anderen Kacheln (z. B. Satellitenbild) überlagert werden kann, um Hybridkacheln zu erzeugen. |
| labels |
Gibt eine Kachel mit nur den Beschriftungsinformationen der Karte zurück. |
| terra |
Zuordnen des Zeichenbereichs mit schattierten Reliefkacheln. Zoomstufen 0-6 (einschließlich) werden unterstützt. Png ist das einzige unterstützte TileFormat und nur verfügbar MapTileSize ist 512. |
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. |
MapTileStyle
Die zurückgegebene Kartenformatvorlage. Mögliche Werte sind Haupt-, Dunkel- und shaded_relief.
| Wert | Beschreibung |
|---|---|
| main |
Hauptformatvorlage für Azure Maps |
| dark |
Dunkelgraue Version des Azure Maps-Hauptstils. PNG ist das einzige unterstützte TileFormat. |
| shaded_relief |
Der Hauptstil von Azure Maps wurde mit schattiertem Relief abgeschlossen. Unterstützt von Layer terra. |
TileFormat
Gewünschtes Format der Antwort. Mögliche Werte sind png & Pbf.
| Wert | Beschreibung |
|---|---|
| png |
Ein Bild im PNG-Format. Unterstützt Zoomstufen 0 bis 18. |
| pbf |
Vektorgrafik im Pbf-Format. Unterstützt Zoomstufen 0 bis 22. |