Render - Get Map Static Image

Dienst:

Maps

API-Version:

2024-04-01

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 eignet sich auch zum Einbetten von Karten in Anwendungen außerhalb des Browsers, in Back-End-Dienste, Berichtsgenerierung oder Desktopanwendungen.

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

• Beschriftete Hefter in mehreren Formatvorlagen.
• Rendern von Kreis-, Pfad- und Polygongeometrietypen.

Weitere Informationen und detaillierte Beispiele finden Sie unter Rendern benutzerdefinierter Daten auf einer Rasterkarte.

Die Abmessungen des bbox-Parameters sind je nach Zoomfaktor eingeschränkt. Dadurch wird sichergestellt, dass das resultierende Bild über eine entsprechende Detailebene verfügt.

Zoomstufe	Min. Lon-Bereich	Max. Lon-Bereich	Min. Lat-Bereich	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: Entweder center oder bbox Parameter muss der API bereitgestellt werden.

GET https://atlas.microsoft.com/map/static?api-version=2024-04-01

Mit optionalen Parametern:

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 der 01.04.2024.
bbox	query		number[]	Ein umgebendes Feld 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 minimal zulässigen Bereiche für Lat und Lon werden für jeden Zoomfaktor in der Tabelle oben auf dieser Seite definiert.
center	query		number[]	Koordinaten des Mittelpunkts in doppelter Zahl. Format: 'lon,lat'. Längengradbereich: -180 bis 180. Breitenbereich: -90 bis 90. Hinweis: Entweder zentrieren oder bbox sind erforderliche Parameter. Sie schließen sich gegenseitig aus.
height	query		integer (int32) minimum: 80 maximum: 1500	Höhe des resultierenden Bilds in Pixeln. Reichen 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 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.
path	query		string[]	Pfadformat und Speicherorte (in double). Verwenden Sie diesen Parameter, um dem Bild optional Linien, Polygone oder Kreise hinzuzufügen. Das Pfadformat beschreibt die Darstellung der Linie und Füllung. (Achten Sie darauf, dass Die WERTE dieses Parameters ordnungsgemäß urlcodiert werden, da sie reservierte Zeichen wie Pipes und Interpunktion enthalten.) Der Pfadparameter wird ab S1 in der SKU des Azure Maps-Kontos unterstützt. Mehrere Instanzen des Pfadparameters ermöglichen das Angeben mehrerer Geometrien mit ihren Stilen. Die Anzahl der Parameter pro Anforderung ist auf 10 beschränkt, und die Anzahl der Speicherorte ist auf 100 pro Pfad begrenzt. Um einen Kreis mit Radius 100 Metern und Mittelpunkt am Breitengrad 45°N und Längengrad 122°W mithilfe des Standardstils zu rendern, fügen Sie den Abfragezeichenfolgenparameter hinzu 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 Pfadparameter ohne URL-Codierung aus Gründen der Übersichtlichkeit. Um eine Linie zu rendern, trennen Sie jede Position durch ein Pipezeichen. Verwenden Sie z. B. path=||-122 45|-119.5 43.2|-121.67 47.12 Ein Polygon wird mit einem geschlossenen Pfad angegeben, wobei die ersten und letzten Punkte gleich sind. Verwenden Sie z. B. path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45 Der Längengradwert für Positionen von Linien und Polygonen kann zwischen -360 und 360 liegen, um das Rendern von Geometrien zu ermöglichen, die den Anti-Meridian überschreiten. Formatmodifizierer Sie können die Darstellung des Pfads ändern, indem Sie Formatmodifizierer hinzufügen. Diese werden vor den Speicherorten hinzugefügt. Formatmodifizierer weisen jeweils einen Zweibuchstabennamen auf. Diese abgekürzten Namen werden verwendet, um die Länge der URL zu verringern. Um die Farbe der Kontur zu ändern, verwenden Sie den Modifizierer "lc", und geben Sie die Farbe mit dem HTML/CSS RGB-Farbformat an, bei dem es sich um eine sechsstellige Hexadezimalzahl handelt (die dreistellige Form wird nicht unterstützt). Wenn Sie z. B. eine tiefe rosa Farbe verwenden möchten, die Sie in CSS als #FF1493 angeben würden, verwenden Sie path=lcFF1493||-122 45|-119.5 43.2 Mehrere Modifizierer 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 der Formatmodifizierer Modifikator BESCHREIBUNG Typ Bereich Lc Linienfarbe Schnur 000000 bis FFFFFF fc Füllfarbe Schnur 000000 bis FFFFFF La Zeilen alpha (Deckkraft) Schweben 0 bis 1 fa Füllzeichen (Deckkraft) Schweben 0 bis 1 Lw Linienbreite int32 (0, 50] Ra Kreisradius (Meter) Schweben Größer als 0
pins	query		string[]	Heftenart und Instanzen. Verwenden Sie diesen Parameter, um dem Bild optional Pins hinzuzufügen. Die Heftenart beschreibt das Erscheinungsbild der Hefter, und die Instanzen geben die Koordinaten der Pins (in Doppel) und optionale Beschriftungen für jeden Pin an. (Achten Sie darauf, dass Die WERTE dieses Parameters ordnungsgemäß urlcodiert werden, da sie reservierte Zeichen wie Pipes und Interpunktion enthalten.) Das Azure Maps-Konto S0 SKU unterstützt nur eine einzelne Instanz des Pins-Parameters, und die Anzahl der Speicherorte ist auf 5 pro Pin beschränkt. Andere SKUs ermöglichen bis zu 25 Instanzen des Pins-Parameters, mehrere Pinformatvorlagen anzugeben, und die Anzahl der Speicherorte ist auf 50 pro Pin beschränkt. Fügen Sie den Abfragezeichenfolgenparameter hinzu, um eine Stecknadel am Breitengrad 45°N und Längengrad 122°W mithilfe der integrierten Standard-Pin-Formatvorlage 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, um Klarheit zu erhalten. Um eine Pin an mehreren Stellen zu rendern, trennen Sie jede Position durch ein Pipezeichen. Verwenden Sie z. B. pins=default||-122 45|-119.5 43.2|-121.67 47.12 Die S0 Azure Maps-Konto-SKU lässt nur fünf Pins zu. Andere Konto-SKUs haben diese Einschränkung nicht. Formatmodifizierer Sie können die Darstellung der Ortsmarken durch Hinzufügen von Stilmodifizierern ändern. Diese werden nach der Formatvorlage, aber vor den Speicherorten und Beschriftungen hinzugefügt. Formatmodifizierer weisen jeweils einen Zweibuchstabennamen auf. Diese abgekürzten Namen werden verwendet, um die Länge der URL zu verringern. Um die Farbe der Pin zu ändern, verwenden Sie den Modifizierer "co", und geben Sie die Farbe mit dem HTML/CSS RGB-Farbformat an, bei dem es sich um eine sechsstellige Hexadezimalzahl handelt (die dreistellige Form wird nicht unterstützt). Wenn Sie z. B. eine tiefe rosa Farbe verwenden möchten, die Sie in CSS als #FF1493 angeben würden, verwenden Sie pins=default|coFF1493||-122 45 Stecknadelbeschriftungen Wenn Sie den Pins eine Beschriftung hinzufügen möchten, platzieren Sie die Beschriftung direkt vor den Koordinaten in einfache Anführungszeichen. Vermeiden Sie die Verwendung von Sonderzeichen wie | oder || in der Beschriftung. Wenn Sie beispielsweise drei Pins mit den Werten "1", "2" und "3" beschriften möchten, verwenden Sie pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12 Es gibt eine integrierte Pin-Formatvorlage namens "none", die kein Hefterbild anzeigt. Sie können dies verwenden, wenn Sie Beschriftungen ohne Pinbild anzeigen möchten. Beispiel: pins=none||'A'-122 45|'B'-119.5 43.2 Um die Farbe der Heftbeschriftungen zu ändern, verwenden Sie den Modifizierer "lc". Wenn Sie z. B. rosa Hefter mit schwarzen Etiketten verwenden möchten, verwenden Sie pins=default|coFF1493|lc000000||-122 45 Verwenden Sie den Modifizierer für die Beschriftungsformatvorlage "ls", um die Größe der Beschriftungen zu ändern. Die Beschriftungsgröße stellt die ungefähre Höhe des Beschriftungstexts in Pixel dar. Wenn Sie beispielsweise die Beschriftungsgröße auf 12 erhöhen möchten, verwenden Sie pins=default|ls12||'A'-122 45|'B'-119 43 Die Etiketten werden an der Stecknadel "Etikettenanker" zentriert. Die Verankerungsposition ist für integrierte Stecknadeln vordefiniert und befindet sich in der oberen Mitte von benutzerdefinierten Stecknadeln (siehe unten). Um den Bezeichnungsanker außer Kraft zu setzen, verwenden Sie den Modifizierer "la" und stellen X- und Y-Pixelkoordinaten für den Anker bereit. Diese Koordinaten sind relativ zur oberen linken Ecke des Hefterbilds. Positive X-Werte verschieben den Anker nach rechts, und positive Y-Werte verschieben den Anker nach unten. Um z. B. die Beschriftungsanker 10 Pixel rechts und 4 Pixel über der oberen linken Ecke des Heftbilds zu positionieren, verwenden Sie pins=default|la10 -4||'A'-122 45|'B'-119 43 Benutzerdefinierte Pins Um ein benutzerdefiniertes Pin-Bild zu verwenden, verwenden Sie das Wort "benutzerdefiniert" als Namen der Pinformatvorlage, und geben Sie dann eine URL nach den Standort- und Bezeichnungsinformationen an. Die maximale zulässige Größe für ein angepasstes Etikettenbild 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 würde dies wie folgt aussehen: pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png Standardmäßig werden benutzerdefinierte Pin-Bilder zentriert an den Pinkoordinaten gezeichnet. Dies ist in der Regel nicht ideal, da sie den Speicherort verdeckt, den Sie hervorheben möchten. Um die Verankerungsposition des Pinbilds außer Kraft zu setzen, verwenden Sie den Modifizierer "an". Dies verwendet das gleiche Format wie der Modifizierer "la"-Bezeichnungsanker. Wenn ihr benutzerdefiniertes Pinbild z. B. die Spitze der Stecknadel in der oberen linken Ecke des Bilds aufweist, können Sie den Anker mithilfe dieser Stelle festlegen. 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 aber den Alphakanal (Deckkraft) unverändert. Dies wäre in der Regel nur mit einem benutzerdefinierten Volltonbild möglich. Skalierung, Drehung und Deckkraft Mithilfe des Modifizierers "sc" können Sie Heftmarken und deren Beschriftungen vergrößern oder verkleinern. Dies ist ein Wert größer als Null. Der Wert 1 ist die Standardskalierung. Werte, die größer als 1 sind, machen die Pins größer, und werte kleiner als 1 machen sie kleiner. Wenn Sie beispielsweise die Hefter 50% größer als normal zeichnen möchten, verwenden Sie pins=default|sc1.5||-122 45 Sie können Hefter und deren Beschriftungen mithilfe des Modifizierers "ro" drehen. Dies ist eine Reihe von Grad der Drehung im Uhrzeigersinn. Verwenden Sie eine negative Zahl, um gegen den Uhrzeigersinn zu drehen. Um beispielsweise die Hefter um 90 Grad im Uhrzeigersinn zu drehen und ihre Größe zu verdoppeln, verwenden Sie pins=default|ro90|sc2||-122 45 Sie können Pins und ihre Beschriftungen teilweise transparent machen, indem Sie den Modifizierer "al" im Alphastil angeben. Dies ist eine Zahl zwischen 0 und 1, die die Deckkraft der Hefter angibt. Null macht sie vollständig transparent (und nicht sichtbar) und 1 macht sie vollständig undurchsichtig (die Standardeinstellung). Verwenden Sie z. B. 67% undurchsichtig, um Pins und deren Etiketten zu machen. pins=default|al.67||-122 45 Zusammenfassung der Formatmodifizierer Modifikator BESCHREIBUNG Typ Bereich al Alpha (Deckkraft) Schweben 0 bis 1 ein Anker anheften <int32, int32> * co Pinfarbe Schnur 000000 bis FFFFFF La Bezeichnungsanker <int32, int32> * Lc Beschriftungsfarbe Schnur 000000 bis FFFFFF Ls Etikettengröße Schweben Größer als 0 ro Drehung Schweben -360 bis 360 sc Maßstab Schweben Größer als 0 X- und Y-Koordinaten können an einer beliebigen Stelle innerhalb des Pinbilds oder eines Rands um sie herum liegen. Die Randgröße ist das Minimum der Pinbreite und -höhe.
tilesetId	query		TilesetId	Die zurückgegebene Kartenformatvorlage. 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-KachelnetId-.
trafficLayer	query		TrafficTilesetId	Optionaler Wert, der angibt, dass kein Datenverkehrsfluss für das Bildergebnis überlagert ist. Mögliche Werte sind "microsoft.traffic.relative.main" und "none". Der Standardwert ist keine, der angibt, dass kein Datenverkehrsfluss zurückgegeben wird. Wenn datenverkehrsbezogene KachelnetId bereitgestellt wird, wird das Kartenbild mit entsprechender Datenverkehrsebene zurückgegeben. Weitere Informationen finden Sie unter Render-KachelnetId-.
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 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.
width	query		integer (int32) minimum: 80 maximum: 2000	Breite des resultierenden Bilds in Pixeln. Reichen von 80 bis 2000. Der Standardwert ist 512. Es sollte nicht mit bbox verwendet werden.
zoom	query		integer (int32) minimum: 0 maximum: 20	Gewünschter Zoomfaktor der Karte. Unterstützen Sie den Zoomwertbereich von 0 bis 20 (einschließlich) für KachelnetId, die "microsoft.base.road" oder "microsoft.base.darkgrey" ist. Unterstützen Sie den Zoomwertbereich von 0 bis 19 (einschließlich) für kacheletId, die "microsoft.imagery" ist. Der Standardwert ist 12. Weitere Informationen finden Sie unter Zoomstufen und Kachelraster-.

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.
Accept		MediaType	Das Accept-Header-Feld kann verwendet werden, um Einstellungen für Antwortmedientypen festzulegen. Zu den zulässigen Medientypen gehören image/jpeg und image/png. Gibt image 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 von 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. 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 Static Image Request

Beispielanforderung

HTTP

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

Statuscode:

200

Content-Type: image/png

"{file}"

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
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.
MediaType	Das Accept-Header-Feld kann verwendet werden, um Einstellungen für Antwortmedientypen festzulegen. Zu den zulässigen Medientypen gehören image/jpeg und image/png. Gibt image in image/png zurück, wenn der Accept-Header nicht angegeben ist.
TilesetId	Die zurückgegebene Kartenformatvorlage. 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-KachelnetId-.
TrafficTilesetId	Optionaler Wert, der angibt, dass kein Datenverkehrsfluss für das Bildergebnis überlagert ist. Mögliche Werte sind "microsoft.traffic.relative.main" und "none". Der Standardwert ist keine, der angibt, dass kein Datenverkehrsfluss zurückgegeben wird. Wenn datenverkehrsbezogene KachelnetId bereitgestellt wird, wird das Kartenbild mit entsprechender Datenverkehrsebene zurückgegeben. Weitere Informationen finden Sie unter Render-KachelnetId-.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

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

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

LocalizedMapView

Enumeration

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)

MediaType

Enumeration

Das Accept-Header-Feld kann verwendet werden, um Einstellungen für Antwortmedientypen festzulegen. Zu den zulässigen Medientypen gehören image/jpeg und image/png. Gibt image in image/png zurück, wenn der Accept-Header nicht angegeben ist.

Wert	Beschreibung
image/png	Geben Sie das Bild im PNG-Format zurück.
image/jpeg	Geben Sie das Bild im JPEG-Format zurück.

TilesetId

Enumeration

Die zurückgegebene Kartenformatvorlage. 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-KachelnetId-.

Wert	Beschreibung
microsoft.base.road	TilesetId enthält alle Layer mit dem Rendering-Hauptstil.
microsoft.base.darkgrey	TilesetId enthält alle Ebenen mit unserem dunkelgrauen Stil.
microsoft.imagery	TilesetId enthält eine Kombination aus Satelliten- und Luftbildern.

TrafficTilesetId

Enumeration

Optionaler Wert, der angibt, dass kein Datenverkehrsfluss für das Bildergebnis überlagert ist. Mögliche Werte sind "microsoft.traffic.relative.main" und "none". Der Standardwert ist keine, der angibt, dass kein Datenverkehrsfluss zurückgegeben wird. Wenn datenverkehrsbezogene KachelnetId bereitgestellt wird, wird das Kartenbild mit entsprechender Datenverkehrsebene zurückgegeben. Weitere Informationen finden Sie unter Render-KachelnetId-.

Wert	Beschreibung
microsoft.traffic.relative.main	Unterstützte TilesetId im Zusammenhang mit dem Datenverkehr.
none	Standardwert, kein Traffic-Flow-Overlay.