Freigeben über


Render - Get Map Static Image

Diese Rendering-API erzeugt statische, gerasterte Kartenansichten eines benutzerdefinierten Bereichs. Es eignet sich für einfache Webanwendungen, wenn die gewünschte Benutzeroberfläche keine interaktiven Kartensteuerelemente erfordert oder wenn die Bandbreite begrenzt ist. Diese API ist auch nützlich zum Einbetten von Karten in Anwendungen außerhalb des Browsers, in Back-End-Diensten, berichtsgenerierung oder Desktopanwendungen.

Diese API enthält Parameter für die grundlegende Datenvisualisierung:

  • Beschriftete Pushpins in mehreren Formaten.
  • Rendern von Kreis-, Pfad- und Polygongeometrietypen.

Weitere Informationen und ausführliche Beispiele finden Sie unter Rendern von benutzerdefinierten Daten in einer Rasterzuordnung.

Die Dimensionen des bbox-Parameters sind abhängig von der Zoomstufe eingeschränkt. Dadurch wird sichergestellt, dass das resultierende Bild über einen angemessenen Detailgrad verfügt.

Zoomfaktor Min Lon Range Max. Lon-Bereich Min Lat Range Maximaler Lat-Bereich
0 56,25 360.0 30.1105585173 180.0
1 28,125 360.0 14.87468995 180.0
2 14.063 351.5625 7.4130741851 137.9576312246
3 7.03125 175.78125 3.7034501005 73.6354071932
4 3.515625 87.890625 1.8513375155 35.4776115315
5 1.7578125 43.9453125 0.925620264 17.4589959239
6 0.87890625 21.97265625 0.4628040687 8.6907788223
7 0.439453125 10.986328125 0.2314012764 4.3404320789
8 0.2197265625 5.4931640625 0.1157005434 2.1695927024
9 0.1098632812 2.7465820312 0.0578502599 1.0847183194
10 0.0549316406 1.3732910156 0.0289251285 0.5423494021
11 0.0274658203 0.6866455078 0.014462564 0.2711734813
12 0.0137329102 0.3433227539 0.007231282 0.1355865882
13 0.0068664551 0.171661377 0.003615641 0.067793275
14 0.0034332275 0.0858306885 0.0018078205 0.0338966351
15 0.0017166138 0.0429153442 0.0009039102 0.0169483173
16 0.0008583069 0.0214576721 0.0004519551 0.0084741586
17 0.0004291534 0.0107288361 0.0002259776 0.0042370793
18 0.0002145767 0.005364418 0.0001129888 0.0021185396
19 0.0001072884 0.002682209 5.64944E-05 0.0010592698
20 5.36442E-05 0.0013411045 2.82472E-05 0.0005296349

Hinweis : Der Center - oder bbox-Parameter muss für die API angegeben werden.

GET https://atlas.microsoft.com/map/static?api-version=2024-04-01
GET https://atlas.microsoft.com/map/static?api-version=2024-04-01&tilesetId={tilesetId}&trafficLayer={trafficLayer}&zoom={zoom}&center={center}&bbox={bbox}&height={height}&width={width}&language={language}&view={view}&pins={pins}&path={path}

URI-Parameter

Name In Erforderlich Typ Beschreibung
api-version
query True

string

Versionsnummer der Azure Maps API. Die aktuelle Version ist 2024-04-01.

bbox
query

number[]

Ein Begrenzungsrahmen wird durch zwei Breiten und zwei Längengrade definiert, die die vier Seiten eines rechteckigen Bereichs auf der Erde darstellen. Format: 'minLon, minLat, maxLon, maxLat' (in double).

Hinweis: Entweder bbox oder center sind erforderliche Parameter. Sie schließen sich gegenseitig aus. bbox sollte nicht mit Höhe oder Breite verwendet werden.

Die maximalen und minimalen zulässigen Bereiche für Lat und Lon werden für jede Zoomstufe in der Tabelle oben auf dieser Seite definiert.

center
query

number[]

Koordinaten des Mittelpunkts in double. Format: 'lon,lat'. Längengrad: -180 bis 180. Breitenbereich: -90 bis 90.

Hinweis: Entweder center oder bbox sind erforderliche Parameter. Sie schließen sich gegenseitig aus.

height
query

integer

int32

Höhe des resultierenden Bilds in Pixel. Bereich von 80 bis 1500. Der Standardwert ist 512. Es sollte nicht mit bbox verwendet werden.

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 .

path
query

string[]

Pfadformat und Speicherorte (in double). Verwenden Sie diesen Parameter, um dem Bild optional Linien, Polygone oder Kreise hinzuzufügen. Der Pfadstil beschreibt die Darstellung der Zeile und der Füllung. (Stellen Sie sicher, dass Werte dieses Parameters ordnungsgemäß urlcodiert werden, da er reservierte Zeichen wie Pipes und Interpunktion enthält.)

Der Pfadparameter wird in der Azure Maps-Konto-SKU ab S1 unterstützt. Mehrere Instanzen des path-Parameters ermöglichen das Angeben mehrerer Geometrien mit ihren Stilen. Die Anzahl der Parameter pro Anforderung ist auf 10 und die Anzahl der Standorte auf 100 pro Pfad beschränkt.

Fügen Sie den parameter querystring hinzu, um einen Kreis mit Radius von 100 Metern und einem Mittelpunkt auf 45°N und 122°W Längengrad zu rendern.

path=ra100||-122 45

Beachten Sie, dass der Längengrad vor dem Breitengrad liegt. Nach der URL-Codierung sieht dies wie folgt aus:

path=ra100%7C%7C-122+45

Alle hier aufgeführten Beispiele zeigen den path-Parameter ohne URL-Codierung, um die Übersichtlichkeit zu erhöhen.

Um eine Zeile zu rendern, trennen Sie jede Position durch ein Pipezeichen. Verwenden Sie beispielsweise

path=||-122 45|-119.5 43.2|-121.67 47.12

Ein Polygon wird mit einem geschlossenen Pfad angegeben, wobei der erste und der letzte Punkt gleich sind. Verwenden Sie beispielsweise

path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45

Der Längengrad für Positionen von Linien und Polygonen kann im Bereich von -360 bis 360 liegen, um das Rendern von Geometrien zu ermöglichen, die den Antimeridian überschreiten.

Stilmodifizierer

Sie können die Darstellung des Pfads ändern, indem Sie Stilmodifizierer hinzufügen. Diese werden vor den Speicherorten hinzugefügt. Stilmodifizierer haben jeweils einen namen aus zwei Buchstaben. Diese abgekürzten Namen werden verwendet, um die Länge der URL zu verringern.

Um die Farbe der Kontur zu ändern, verwenden Sie den Formatmodifizierer "lc", und geben Sie die Farbe mit dem HTML/CSS-RGB-Farbformat an, das eine sechsstellige Hexadezimalzahl ist (die dreistellige Form wird nicht unterstützt). Um beispielsweise eine tief rosa Farbe zu verwenden, die Sie als #FF1493 in CSS angeben würden, verwenden Sie

path=lcFF1493||-122 45|-119.5 43.2

Mehrere Stilmodifizierer können kombiniert werden, um einen komplexeren visuellen Stil zu erstellen.

lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6

Zusammenfassung des Formatmodifizierers

Modifizierer BESCHREIBUNG type Range
Lc Linienfarbe Zeichenfolge 000000 bis FFFFFF
fc Füllfarbe Zeichenfolge 000000 bis FFFFFF
la Linien alpha (Deckkraft) float 0 bis 1
fa Füll-Alpha (Deckkraft) float 0 bis 1
Lw Linienstärke int32 (0, 50]
Ra Kreisradius (Meter) float Größer als 0
pins
query

string[]

Pushpin-Stil und -Instanzen. Verwenden Sie diesen Parameter, um dem Bild optional Pushpins hinzuzufügen. Der Druckstiftstil beschreibt das Erscheinungsbild der Druckstifte, und die Instanzen geben die Koordinaten der Druckstifte (doppelt) und optionale Bezeichnungen für jeden Pin an. (Stellen Sie sicher, dass Die Werte dieses Parameters ordnungsgemäß URL codiert werden, da er reservierte Zeichen wie Pipes und Interpunktion enthält.)

Die S0-SKU des Azure Maps-Kontos unterstützt nur eine einzelne Instanz des Pins-Parameters. Andere SKUs ermöglichen es mehreren Instanzen des Pins-Parameters, mehrere Pinstile anzugeben.

Fügen Sie den Querystring-Parameter hinzu, um einen Pushpin-Wert im Breitengrad 45°N und einem Längengrad von 122°W mithilfe des integrierten Standard-Pushpin-Stils zu rendern.

pins=default||-122 45

Beachten Sie, dass der Längengrad vor dem Breitengrad liegt. Nach der URL-Codierung sieht dies wie folgt aus.

pins=default%7C%7C-122+45

Alle hier aufgeführten Beispiele zeigen den Pins-Parameter ohne URL-Codierung zur Übersichtlichkeit.

Um einen Pin an mehreren Stellen zu rendern, trennen Sie jede Position mit einem Pipezeichen. Verwenden Sie beispielsweise

pins=default||-122 45|-119.5 43.2|-121.67 47.12

Die S0 Azure Maps-Konto-SKU lässt nur fünf Pushpins zu. Für andere Konto-SKUs gilt diese Einschränkung nicht.

Stilmodifizierer

Sie können die Darstellung der Ortsmarken durch Hinzufügen von Stilmodifizierern ändern. Diese werden nach dem Format, aber vor den Speicherorten und Bezeichnungen hinzugefügt. Stilmodifizierer haben jeweils einen Namen aus zwei Buchstaben. Diese abgekürzten Namen werden verwendet, um die Länge der URL zu verringern.

Um die Farbe der Drucknadel zu ändern, verwenden Sie den Formatmodifizierer "co", und geben Sie die Farbe mit dem HTML/CSS-RGB-Farbformat an, das eine sechsstellige hexadezimale Zahl ist (die dreistellige Form wird nicht unterstützt). Um beispielsweise eine tief rosa Farbe zu verwenden, die Sie als #FF1493 in CSS angeben würden, verwenden Sie

pins=default|coFF1493||-122 45

Drucknadelbeschriftungen

Um den Pins eine Bezeichnung hinzuzufügen, setzen Sie die Bezeichnung in einzelne Anführungszeichen direkt vor den Koordinaten. Vermeiden Sie die Verwendung von Sonderzeichen wie | oder || in der Bezeichnung. Um beispielsweise drei Pins mit den Werten "1", "2" und "3" zu kennzeichnen, verwenden Sie

pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12

Es gibt einen integrierten Pushpin-Stil namens "none", in dem kein Pushpin-Image angezeigt wird. Sie können dies verwenden, wenn Sie Bezeichnungen ohne Anheften anzeigen möchten. Beispiel:

pins=none||'A'-122 45|'B'-119.5 43.2

Um die Farbe der Druckpinbeschriftungen zu ändern, verwenden Sie den Farbformatmodifizierer "lc". Um z. B. rosa Druckpins mit schwarzen Etiketten zu verwenden, verwenden Sie

pins=default|coFF1493|lc000000||-122 45

Um die Größe der Bezeichnungen zu ändern, verwenden Sie den Beschriftungsformatmodifizierer "ls". Die Bezeichnungsgröße stellt die ungefähre Höhe des Bezeichnungstexts in Pixel dar. Verwenden Sie beispielsweise, um die Bezeichnungsgröße auf 12 zu erhöhen.

pins=default|ls12||'A'-122 45|'B'-119 43

Die Bezeichnungen werden am Drucknadel "Bezeichnungsanker" zentriert. Der Ankerstandort ist für integrierte Druckpins vordefiniert und befindet sich in der oberen Mitte der benutzerdefinierten Stecknadeln (siehe unten). Zum Überschreiben des Bezeichnungsankers verwenden Sie den Modifizierer "la" und geben X- und Y-Pixelkoordinaten für den Anker an. Diese Koordinaten sind relativ zur oberen linken Ecke des Drucknadelbilds. Positive X-Werte verschieben den Anker nach rechts, und positive Y-Werte verschieben den Anker nach unten. Verwenden Sie beispielsweise, um den Bezeichnungsanker 10 Pixel rechts und 4 Pixel über der oberen linken Ecke des Drucknadelbilds zu positionieren.

pins=default|la10 -4||'A'-122 45|'B'-119 43

Benutzerdefinierte Pushpins

Um ein benutzerdefiniertes Pushpin-Bild zu verwenden, verwenden Sie das Wort "custom" als Namen der Anheftformatvorlage, und geben Sie dann eine URL nach den Informationen zu Speicherort und Bezeichnung an. Die maximal zulässige Größe für ein benutzerdefiniertes Bezeichnungsbild beträgt 65.536 Pixel. Verwenden Sie zwei Pipezeichen, um anzugeben, dass Sie mit der Angabe von Speicherorten fertig sind und die URL starten. Beispiel:

pins=custom||-122 45||http://contoso.com/pushpins/red.png

Nach der URL-Codierung sieht dies wie folgt aus:

pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png

Standardmäßig werden benutzerdefinierte Stiftbilder zentriert an den Pinkoordinaten gezeichnet. Dies ist in der Regel nicht ideal, da es den Speicherort verdeckt, den Sie hervorheben möchten. Um die Ankerposition des Anheftbilds zu überschreiben, verwenden Sie den Formatmodifizierer "an". Dabei wird das gleiche Format wie der Modifizierer "la" für den Ankerstil verwendet. Wenn ihr benutzerdefiniertes Stecknadelbild beispielsweise die Spitze des Stifts in der oberen linken Ecke des Bilds aufweist, können Sie den Anker auf diese Stelle festlegen, indem Sie

pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png

Hinweis: Wenn Sie den Farbmodifizierer "co" mit einem benutzerdefinierten Pinbild verwenden, ersetzt die angegebene Farbe die RGB-Kanäle der Pixel im Bild, lässt jedoch den Alphakanal (Deckkraft) unverändert. Dies würde in der Regel nur mit einem benutzerdefinierten Volltonbild erfolgen.

Skalierung, Drehung und Deckkraft

Sie können Ortsmarken und ihre Bezeichnungen vergrößern oder verkleinern, indem Sie den Skalierungsmodifikator „sc“ verwenden. Dies ist ein Wert größer als 0. Der Wert 1 ist die Standardskalierung. Werte größer als 1 machen die Ortsmarken größer, und Werte kleiner als 1 machen sie kleiner. Verwenden Sie beispielsweise, um die Pins 50 % größer als normal zu zeichnen.

pins=default|sc1.5||-122 45

Mithilfe des Modifizierers "ro" können Sie Pins und deren Bezeichnungen drehen. Dies ist eine Reihe von Graden der Drehung im Uhrzeigersinn. Verwenden Sie eine negative Zahl, um gegen den Uhrzeigersinn zu drehen. Verwenden Sie beispielsweise, um die Pins um 90 Grad im Uhrzeigersinn zu drehen und ihre Größe zu verdoppeln.

pins=default|ro90|sc2||-122 45

Sie können Pins und deren Bezeichnungen teilweise transparent machen, indem Sie den Alphaformatmodifizierer "al" angeben. Dies ist eine Zahl zwischen 0 und 1, die die Deckkraft der Pins angibt. Null macht sie vollständig transparent (und nicht sichtbar) und 1 macht sie vollständig undurchsichtig (dies ist die Standardeinstellung). Verwenden Sie beispielsweise, um Druckmarken und deren Bezeichnungen nur zu 67 % undurchsichtig zu machen.

pins=default|al.67||-122 45

Zusammenfassung des Formatmodifizierers

Modifizierer BESCHREIBUNG type Range
al Alpha (Deckkraft) float 0 bis 1
ein Anker anheften <int32, int32> *
co Anheften der Farbe Zeichenfolge 000000 bis FFFFFF
la Bezeichnungsanker <int32, int32> *
Lc Beschriftungsfarbe Zeichenfolge 000000 bis FFFFFF
ls Bezeichnungsgröße float Größer als 0
ro Drehung float -360 bis 360
sc Skalieren float Größer als 0
  • X- und Y-Koordinaten können sich an einer beliebigen Stelle innerhalb des Pinbilds oder an einem Rand um das Bild befinden. Die Randgröße ist das Minimum der Stiftbreite und -höhe.
tilesetId
query

TilesetId

Zurückzugebende Kartenformat Mögliche Werte sind microsoft.base.road, microsoft.base.darkgrey und microsoft.imagery. Der Standardwert ist auf microsoft.base.road festgelegt. Weitere Informationen finden Sie unter Render TilesetId.

trafficLayer
query

TrafficTilesetId

Optionaler Wert, der angibt, dass kein Datenverkehrsfluss mit dem Bildergebnis überlagert wird. Mögliche Werte sind microsoft.traffic.relative.main und none. Der Standardwert ist none, was angibt, dass kein Datenverkehrsfluss zurückgegeben wurde. Wenn datenverkehrsbezogene TilesetId bereitgestellt wird, wird das Kartenbild mit der entsprechenden Datenverkehrsebene zurückgegeben. Weitere Informationen finden Sie unter Render TilesetId.

view
query

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 .

width
query

integer

int32

Breite des resultierenden Bilds in Pixel. Bereich von 80 bis 2000. Der Standardwert ist 512. Es sollte nicht mit bbox verwendet werden.

zoom
query

integer

int32

Gewünschte Zoomstufe der Karte. Unterstützung des Zoomwertbereichs von 0 bis 20 (inklusive) für tilesetId als microsoft.base.road oder microsoft.base.darkgrey. Unterstützung des Zoomwertbereichs von 0 bis 19 (einschließlich) für tilesetId ist microsoft.imagery. Der Standardwert ist 12.

Weitere Informationen finden Sie unter Zoomstufen und Kachelraster.

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 .

Accept

MediaType

Das Feld Accept-Header kann verwendet werden, um Einstellungen für Antwortmedientypen anzugeben. Zulässige Medientypen sind image/jpeg und image/png. Geben Sie das Bild in image/png zurück, wenn der Accept-Header nicht angegeben ist.

Antworten

Name Typ Beschreibung
200 OK

object

Dieses Bild wird von einem erfolgreichen Aufruf "Get Map Static Image" zurückgegeben.

Media Types: "image/jpeg", "image/png"

Header

Content-Type: string

Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Media Types: "image/jpeg", "image/png"

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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 jedem 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.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

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.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Zugriffssteuerung in 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 das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.

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, 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 wurden.

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

Hierbei handelt es sich um 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 autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Successful Static Image Request

Beispielanforderung

GET https://atlas.microsoft.com/map/static?api-version=2024-04-01&tilesetId=microsoft.base.road&zoom=10&center=-122.177621,47.613079

Beispiel für eine Antwort

Content-Type: image/png
"{file}"

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 .

MediaType

Das Feld Accept-Header kann verwendet werden, um Einstellungen für Antwortmedientypen anzugeben. Zulässige Medientypen sind image/jpeg und image/png. Geben Sie das Bild in image/png zurück, wenn der Accept-Header nicht angegeben ist.

TilesetId

Zurückzugebende Kartenformat Mögliche Werte sind microsoft.base.road, microsoft.base.darkgrey und microsoft.imagery. Der Standardwert ist auf microsoft.base.road festgelegt. Weitere Informationen finden Sie unter Render TilesetId.

TrafficTilesetId

Optionaler Wert, der angibt, dass kein Datenverkehrsfluss mit dem Bildergebnis überlagert wird. Mögliche Werte sind microsoft.traffic.relative.main und none. Der Standardwert ist none, was angibt, dass kein Datenverkehrsfluss zurückgegeben wurde. Wenn datenverkehrsbezogene TilesetId bereitgestellt wird, wird das Kartenbild mit der entsprechenden Datenverkehrsebene zurückgegeben. Weitere Informationen finden Sie unter Render TilesetId.

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)

MediaType

Das Feld Accept-Header kann verwendet werden, um Einstellungen für Antwortmedientypen anzugeben. Zulässige Medientypen sind image/jpeg und image/png. Geben Sie das Bild in image/png zurück, wenn der Accept-Header nicht angegeben ist.

Name Typ Beschreibung
image/jpeg

string

Zurückgeben eines Bilds im JPEG-Format.

image/png

string

Zurückgeben des Bilds im PNG-Format.

TilesetId

Zurückzugebende Kartenformat Mögliche Werte sind microsoft.base.road, microsoft.base.darkgrey und microsoft.imagery. Der Standardwert ist auf microsoft.base.road festgelegt. Weitere Informationen finden Sie unter Render TilesetId.

Name Typ Beschreibung
microsoft.base.darkgrey

string

TilesetId enthält alle Ebenen mit unserem dunkelgrauen Stil.

microsoft.base.road

string

TilesetId enthält alle Ebenen mit rendering-Hauptformat.

microsoft.imagery

string

TilesetId enthält eine Kombination aus Satelliten- und Luftbildern.

TrafficTilesetId

Optionaler Wert, der angibt, dass kein Datenverkehrsfluss mit dem Bildergebnis überlagert wird. Mögliche Werte sind microsoft.traffic.relative.main und none. Der Standardwert ist none, was angibt, dass kein Datenverkehrsfluss zurückgegeben wurde. Wenn datenverkehrsbezogene TilesetId bereitgestellt wird, wird das Kartenbild mit der entsprechenden Datenverkehrsebene zurückgegeben. Weitere Informationen finden Sie unter Render TilesetId.

Name Typ Beschreibung
microsoft.traffic.relative.main

string

Unterstützte datenverkehrsbezogene TilesetId.

none

string

Standardwert, keine Überlagerung des Datenverkehrs.