Freigeben über


Render - Get Map Image

Wird verwendet, um ein benutzerdefiniertes, rechteckiges Bild mit einem Kartenabschnitt mithilfe eines Zoomfaktors zwischen 0 und 20 zu rendern.

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.

Der unterstützte Auflösungsbereich für das Kartenbild liegt zwischen 1x1 und 8192x8192. Wenn Sie entscheiden, wann der statische Bilddienst über den Kartenkacheldienst verwendet werden soll, sollten Sie überlegen, wie Sie mit der gerenderten Karte interagieren möchten. Wenn der Karteninhalt relativ unveränderlich ist, ist eine statische Karte eine gute Wahl. Wenn Sie viele Zoom-, Verschiebungs- und Änderungsfunktionen des Karteninhalts unterstützen möchten, wäre der Kartenkacheldienst eine bessere Wahl.

Der Dienst bietet außerdem Bildkompositionsfunktionen, um ein statisches Bild mit zusätzlichen Daten wie z. B. zurückzuholen. Pushpins und Geometrieüberlagerungen mit folgenden Gen1 S0-, S1- und Gen2-Funktionen.

In Gen1 S0 können Sie:

  • Rendern von bis zu fünf In der Anforderung angegebenen Pins
  • Stellen Sie ein benutzerdefiniertes Bild für die Pins bereit, auf die in der Anforderung verwiesen wird.
  • Hinzufügen von Bezeichnungen zu den Heften

In Gen1 S1 und Gen2 können Sie:

  • Rendern von Stecknadeln über Azure Maps Data Service
  • Angeben mehrerer Heftformatvorlagen
  • Rendern von Kreis-, Polyline- und Polygongeometrietypen.
  • Rendern von unterstützten GeoJSON-Geometrietypen, die über Azure Maps Data Service hochgeladen wurden

Ausführliche Beispiele finden Sie in der Anleitung Rendern von benutzerdefinierten Daten auf einer Rasterkarte.

Hinweis: Entweder center oder bbox Parameter muss der API bereitgestellt werden.

Die unterstützten Lat- und Lon-Bereiche bei Verwendung des bbox-Parameters sind wie folgt:

Zoomstufe Max. Lon-Bereich Maximaler Lat-Bereich
0 360.0 170.0
1 360.0 170.0
2 360.0 170.0
3 360.0 170.0
4 360.0 170.0
5 180.0 85.0
6 90.0 42.5
7 45.0 21.25
8 22,5 10.625
9 11.25 5.3125
10 5.625 2.62625
11 2.8125 1.328125
12 1.40625 0.6640625
13 0.703125 0.33203125
14 0.3515625 0.166015625
15 0.17578125 0.0830078125
16 0.087890625 0.0415039063
17 0.0439453125 0.0207519531
18 0.0219726563 0.0103759766
19 0.0109863281 0.0051879883
20 0.0054931641 0.0025939941
GET https://atlas.microsoft.com/map/static/png?api-version=1.0
GET https://atlas.microsoft.com/map/static/png?api-version=1.0&layer={layer}&style={style}&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
format
path True

RasterTileFormat

Gewünschtes Format der Antwort. Möglicher Wert: png.

api-version
query True

string

Versionsnummer der Azure Maps-API.

bbox
query

number[]

Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Format: 'minLon, minLat, maxLon, maxLat'.

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

Die maximal 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. Format: 'lon,lat'. Projizierung verwendet

  • EPSG:3857. Längengradbereich: -180 bis 180. Breitenbereich: -85 bis 85.

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

height
query

integer (int32)

minimum: 1
maximum: 8192

Höhe des resultierenden Bilds in Pixeln. Der Bereich beträgt 1 bis 8192. 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.

layer
query

StaticMapLayer

Kartenebene angefordert. Wenn die Ebene auf Beschriftungen oder Hybride festgelegt ist, sollte das Format png sein.

path
query

string[]

Pfadformat und Speicherorte. 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

Zum Rendern eines Polygons muss die letzte Position der Startposition entsprechen. Verwenden Sie z. B.

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

Längengrad- und Breitengradwerte für Positionen von Linien und Polygonen können 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

Abrufen von Pfadspeicherorten aus Azure Maps Data Storage

Für alle Azure Maps-Konto-SKUs außer S0 können die Pfadspeicherortinformationen aus Azure Maps Data Storage abgerufen werden. Nach dem Hochladen eines GeoJSON-Dokuments mit Pfadspeicherorten gibt der Datenspeicherdienst eine eindeutige Daten-ID (UNIQUE Data ID, UDID) zurück, die Sie verwenden können, um auf die Daten im Pfadparameter zu verweisen.

Wenn Sie die Punktgeometrie aus einem hochgeladenen GeoJSON-Dokument als Pfadspeicherorte verwenden möchten, geben Sie die UDID im Abschnitt "Speicherorte" des Pfadparameters an. Beispiel:

path=||udid-29dc105a-dee7-409f-a3f9-22b066ae4713

Beachten Sie, dass es nicht zulässig ist, Pfadspeicherorte aus dem Datenspeicher mit speicherorten zu mischen, die im Pfadparameter angegeben sind.

Zusammenfassung der Formatmodifizierer

Modifikator BESCHREIBUNG Bereich
Lc Linienfarbe 000000 bis FFFFFF
FC Füllfarbe 000000 bis FFFFFF
La Zeilen alpha (Deckkraft) 0 bis 1
fa Füllzeichen (Deckkraft) 0 bis 1
Lw Linienbreite Größer als 0
Ra Kreisradius (Meter) 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 Hefter und optionalen 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. Andere SKUs ermöglichen es mehreren Instanzen des Pins-Parameters, mehrere Pinformatvorlagen anzugeben.

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 Pins ändern, indem Sie Formatmodifizierer hinzufügen. 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. 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 Pinformatvorlage namens "none", die kein Heftenbild 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. 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.

Abrufen von Pins aus Azure Maps-Datenspeicher

Für alle Azure Maps-Konto-SKUs außer S0 können die Standortinformationen der Ortsmarke aus Azure Maps Data Storage abgerufen werden. Nach dem Hochladen eines GeoJSON-Dokuments, das Pinspeicherorte enthält, gibt der Datenspeicherdienst eine eindeutige Daten-ID (UNIQUE Data ID, UDID) zurück, die Sie verwenden können, um auf die Daten im Pins-Parameter zu verweisen.

Wenn Sie die Punktgeometrie aus einem hochgeladenen GeoJSON-Dokument als Pinspeicherorte verwenden möchten, geben Sie die UDID im Abschnitt "Speicherorte" des Pins-Parameters an. Beispiel:

pins=default||udid-29dc105a-dee7-409f-a3f9-22b066ae4713

Beachten Sie, dass nur Punkt- und Multipointgeometrie, Punkte und Multipoints aus Geometriesammlungen und Punktgeometrie von Features verwendet werden. Linienzeichenfolgen- und Polygongeometrie werden ignoriert. Wenn der Punkt von einem Feature stammt und das Feature eine Zeichenfolgeneigenschaft namens "label" aufweist, wird der Wert dieser Eigenschaft als Beschriftung für den Pin verwendet.

Sie können Pinspeicherorte aus Datenspeicher und Pinspeicherorten kombinieren, die im Parameter "Pins" angegeben sind. Jede der durch Rohrtrennzeichen getrennten Pinpositionen kann längengrad und breitengrad oder UDID sein. Beispiel:

pins=default||-122 45|udid-29dc105a-dee7-409f-a3f9-22b066ae4713|-119 43

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. Ein Wert von 1 ist die Standardskala. 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 Bereich
al Alpha (Deckkraft) 0 bis 1
ein Anker anheften *
co Pinfarbe 000000 bis FFFFFF
La Bezeichnungsanker *
Lc Beschriftungsfarbe 000000 bis FFFFFF
Ls Etikettengröße Größer als 0
ro Drehung -360 bis 360
sc Maßstab 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.
style
query

MapImageStyle

Die zurückgegebene Kartenformatvorlage. Mögliche Werte sind Haupt- und Dunkelwerte.

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: 1
maximum: 8192

Breite des resultierenden Bilds in Pixeln. Der Bereich beträgt 1 bis 8192. Der Standardwert ist 512. Es sollte nicht mit bbox verwendet werden.

zoom
query

integer (int32)

minimum: 0
maximum: 20

Gewünschter Zoomfaktor der Karte. Der Zoomwert muss im Bereich 0–20 liegen. 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.

Antworten

Name Typ Beschreibung
200 OK

object

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

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

Header

Content-Type: string

Other Status Codes

ErrorResponse

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.

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 Static Image Request

Beispielanforderung

GET https://atlas.microsoft.com/map/static/png?api-version=1.0&layer=basic&style=main&zoom=2&bbox=1.355233,42.982261,24.980233,56.526017

Beispiel für eine Antwort

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.

MapImageStyle

Die zurückgegebene Kartenformatvorlage. Mögliche Werte sind Haupt- und Dunkelwerte.

RasterTileFormat

Gewünschtes Format der Antwort. Möglicher Wert: png.

StaticMapLayer

Kartenebene angefordert. Wenn die Ebene auf Beschriftungen oder Hybride festgelegt ist, sollte das Format png sein.

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

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

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 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)

MapImageStyle

Die zurückgegebene Kartenformatvorlage. Mögliche Werte sind Haupt- und Dunkelwerte.

Wert Beschreibung
main

Hauptformatvorlage für Azure Maps

dark

Dunkelgraue Version des Azure Maps-Hauptstils

RasterTileFormat

Gewünschtes Format der Antwort. Möglicher Wert: png.

Wert Beschreibung
png

Ein Bild im PNG-Format. Unterstützt Zoomstufen 0 bis 18.

StaticMapLayer

Kartenebene angefordert. Wenn die Ebene auf Beschriftungen oder Hybride festgelegt ist, sollte das Format png sein.

Wert Beschreibung
basic

Gibt ein Bild zurück, das alle Kartenfeatures wie Polygone, Rahmen, Straßen und Beschriftungen enthält.

hybrid

Gibt ein Bild zurück, das Rahmen, Straßen und Bezeichnungen enthält und auf anderen Kacheln (z. B. Satellitenbild) überlagert werden kann, um Hybridkacheln zu erzeugen.

labels

Gibt ein Bild nur der Bezeichnungsinformationen der Karte zurück.