Render - Get Map Static Image

Service:

Maps

API Version:

2022-08-01

Använd för att återge en användardefinierad, rektangulär bild som innehåller ett kartavsnitt med en zoomningsnivå mellan 0 och 20.

Det upplösningsintervall som stöds för kartbilden är från 1x1 till 8192x8192. Om du bestämmer när du ska använda tjänsten för statiska avbildningar över kartpanelstjänsten kanske du vill överväga hur du vill interagera med den renderade kartan. Om kartinnehållet är relativt oförändrat är en statisk karta ett bra val. Om du vill ha stöd för mycket zoomning, panorering och ändring av kartinnehållet skulle kartpanelstjänsten vara ett bättre alternativ.

Tjänsten tillhandahåller även funktioner för bildsammansättning för att få tillbaka en statisk avbildning med ytterligare data som; pushpins och geometriöverlägg med följande funktioner.

• Ange flera pushpin-format
• Rendera cirkel-, polyline- och polygongeometrityper.

Detaljerade exempel finns i Instruktioner .

Obs! Antingen måste center - eller bbox-parametern anges till API:et.

Intervallen Lat och Lon som stöds när du använder bbox-parametern är följande:

Zoomnivå	Max Lon-intervall	Maximalt svarstidsintervall
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=2022-08-01

With optional parameters:

GET https://atlas.microsoft.com/map/static/png?api-version=2022-08-01&layer={layer}&style={style}&zoom={zoom}&center={center}&bbox={bbox}&height={height}&width={width}&language={language}&view={view}&pins={pins}&path={path}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
format	path	True	RasterTileFormat	Önskat format för svaret. Möjligt värde: png.
api-version	query	True	string	Versionsnummer för Azure Maps API. Aktuell version är 2022-08-01
bbox	query		number[]	Markeringsramen. Projektion används – EPSG:3857. Format: "minLon, minLat, maxLon, maxLat". Obs! Antingen bbox eller center krävs parametrar. De utesluter varandra. Den ska inte användas med höjd eller bredd. De högsta tillåtna intervallen för Lat och Lon definieras för varje zoomnivå i tabellen överst på den här sidan.
center	query		number[]	Koordinater för mittpunkten. Format: 'lon,lat'. Projektion används EPSG:3857. Longitudintervall: -180 till 180. Latitudintervall: -85 till 85. Obs! Antingen center eller bbox krävs parametrar. De utesluter varandra.
height	query		integer int32	Höjden på den resulterande bilden i bildpunkter. Intervallet är 1 till 8192. Standardvärdet är 512. Det bör inte användas med bbox.
language	query		string	Språk där sökresultat ska returneras. Bör vara en av IETF-språktaggar som stöds, skiftlägesokänsliga. När data på angivet språk inte är tillgängliga för ett visst fält används standardspråket. Mer information finns i Språk som stöds .
layer	query		StaticMapLayer	Kartlager begärs. Om lagret är inställt på etiketter eller hybrid ska formatet vara png.
path	query		string[]	Sökvägsformat och platser. Använd den här parametern om du vill lägga till linjer, polygoner eller cirklar i bilden. Sökvägsformatet beskriver utseendet på linjen och fyllningen. (Se till att URL-koda värdena för den här parametern korrekt eftersom den innehåller reserverade tecken som pipes och interpunktion.) Sökvägsparametern stöds i Azure Maps konto-SKU som börjar med S1. Flera instanser av sökvägsparametern gör det möjligt att ange flera geometrier med sina format. Antalet parametrar per begäran är begränsat till 10 och antalet platser är begränsat till 100 per sökväg. Om du vill återge en cirkel med radie 100 meter och mittpunkt vid latitud 45°N och longitud 122°W med standardformatet lägger du till parametern querystring path=ra100||-122 45 Observera att longitud kommer före latitud. Efter URL-kodning kommer detta att se ut som path=ra100%7C%7C-122+45 Alla exempel här visar sökvägsparametern utan URL-kodning, för tydlighetens skull. Om du vill återge en linje separerar du varje plats med ett pipe-tecken. Använd till exempel path=||-122 45|-119.5 43.2|-121.67 47.12 Om du vill återge en polygon måste den sista platsen vara lika med startplatsen. Använd till exempel path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45 Longitud- och latitudvärden för platser för linjer och polygoner kan ligga i intervallet från -360 till 360 för att möjliggöra återgivning av geometrier som korsar anti-meridianen. Formatmodifierare Du kan ändra sökvägens utseende genom att lägga till formatmallsmodifierare. Dessa läggs till före platserna. Formatmodifierare har vart och ett ett tvåbokstavsnamn. Dessa förkortade namn används för att minska längden på URL:en. Om du vill ändra färg på dispositionen använder du formatmodifieraren "lc" och anger färgen med färgformatet HTML/CSS RGB som är ett sexsiffrigt hexadecimalt tal (tresiffrigt formulär stöds inte). Om du till exempel vill använda en djuprosa färg som du anger som #FF1493 i CSS använder du path=lcFF1493||-122 45|-119.5 43.2 Flera formatmodifierare kan kombineras för att skapa ett mer komplext visuellt format. 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 Sammanfattning av formatmodifierare Modifierare Description Intervall Lc Linjefärg 0000000 till FFFFFF Fc Fyllningsfärg 0000000 till FFFFFF La Linje alfa (opacitet) 0 till 1 Fa Fyll alfa (opacitet) 0 till 1 Lw Linjebredd Större än 0 Ra Cirkelradie (meter) Större än 0
pins	query		string[]	Pushpin-format och instanser. Använd den här parametern om du vill lägga till pushpins i avbildningen. Kartnålsformatet beskriver utseendet på kartnålarna och instanserna anger koordinaterna för kartnålarna och valfria etiketter för varje stift. (Se till att URL-koda värdena för den här parametern korrekt eftersom den innehåller reserverade tecken som pipes och interpunktion.) S0-SKU:n för Azure Maps-kontot stöder bara en enda instans av pins-parametern. Andra SKU:er tillåter att flera instanser av stiftparametern anger flera stiftformat. Om du vill rendera en pushpin vid latitud 45°N och longitud 122°W med det inbyggda standardformatet för pushpin lägger du till frågesträngsparametern pins=default||-122 45 Observera att longitud kommer före latitud. Efter URL-kodning kommer detta att se ut så här pins=default%7C%7C-122+45 Alla exempel här visar pins-parametern utan URL-kodning, för tydlighetens skull. Om du vill rendera ett stift på flera platser separerar du varje plats med ett vertikalstreck. Använd till exempel pins=default||-122 45|-119.5 43.2|-121.67 47.12 S0-Azure Maps konto-SKU:n tillåter bara fem pushpins. Andra konto-SKU:er har inte den här begränsningen. Formatmallsmodifierare Du kan ändra utseendet på stiften genom att lägga till formatmodifierare. Dessa läggs till efter formatet men före platserna och etiketterna. Formatmodifierare har vart och ett ett tvåbokstavsnamn. Dessa förkortade namn används för att minska LÄNGDEN på URL:en. Om du vill ändra färg på kartnålen använder du formatmodifieraren co och anger färgen med färgformatet HTML/CSS RGB som är ett sexsiffrigt hexadecimalt tal (det tresiffriga formuläret stöds inte). Om du till exempel vill använda en djuprosa färg som du anger som #FF1493 i CSS använder du pins=default|coFF1493||-122 45 Kartnålsetiketter Om du vill lägga till en etikett i stiften placerar du etiketten inom enkla citattecken precis före koordinaterna. Om du till exempel vill märka tre stift med värdena "1", "2" och "3" använder du pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12 Det finns ett inbyggt kartnålsformat med namnet "none" som inte visar en kartnålsbild. Du kan använda detta om du vill visa etiketter utan någon fästbild. Exempel: pins=none||'A'-122 45|'B'-119.5 43.2 Om du vill ändra färg på kartnålsetiketterna använder du färgformatsmodifieraren "lc". Om du till exempel vill använda rosa kartnålar med svarta etiketter använder du pins=default|coFF1493|lc000000||-122 45 Om du vill ändra storlek på etiketterna använder du formatmallsmodifieraren "ls" för etikettstorlek. Etikettstorleken representerar den ungefärliga höjden på etiketttexten i bildpunkter. Om du till exempel vill öka etikettstorleken till 12 använder du pins=default|ls12||'A'-122 45|'B'-119 43 Etiketterna centreras vid kartnålen "etikettfästpunkt". Fästpunktsplatsen är fördefinierad för inbyggda pushpins och ligger längst upp i mitten av anpassade kartnålar (se nedan). Om du vill åsidosätta etikettfästpunkten använder du formatmodifieraren "la" och anger X- och Y-pixelkoordinater för fästpunkten. Dessa koordinater är relativa till det övre vänstra hörnet i pushpin-bilden. Positiva X-värden flyttar fästpunkten till höger och positiva Y-värden flyttar fästpunkten nedåt. Om du till exempel vill placera etikettfästpunkten 10 bildpunkter åt höger och 4 bildpunkter ovanför det övre vänstra hörnet på kartnålsbilden använder du pins=default|la10 -4||'A'-122 45|'B'-119 43 Anpassade kartnålar Om du vill använda en anpassad pushpin-bild använder du ordet "anpassad" som pin-formatmallsnamn och anger sedan en URL efter plats- och etikettinformationen. Använd två vertikalstreck för att ange att du är klar med att ange platser och startar URL:en. Exempel: pins=custom||-122 45||http://contoso.com/pushpins/red.png Efter URL-kodning skulle det se ut så här pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png Som standard ritas anpassade kartnålsbilder centrerade vid stiftkoordinaterna. Detta är vanligtvis inte idealiskt eftersom det döljer den plats som du försöker markera. Om du vill åsidosätta fästpunktsbildens fästpunkt använder du formatmodifieraren "an". Detta använder samma format som "la"-etikettankarformatsmodifieraren. Om din anpassade fästbild till exempel har stiftspetsen i det övre vänstra hörnet av bilden kan du ställa in fästpunkten på den platsen med hjälp av pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png Obs! Om du använder färgmodifieraren "co" med en anpassad kartnålsbild ersätter den angivna färgen RGB-kanalerna för bildpunkterna i bilden, men alfakanalen (ogenomskinlighet) ändras. Detta görs vanligtvis bara med en anpassad bild med en solid färg. Skala, rotera och ogenomskinlighet Du kan göra kartnålar och deras etiketter större eller mindre med hjälp av "sc"-skalningsformatmodifieraren. Det här är ett värde som är större än noll. Värdet 1 är standardskalan. Värden som är större än 1 gör stiften större och värden som är mindre än 1 gör dem mindre. Om du till exempel vill rita kartnålarna 50 % större än normalt använder du pins=default|sc1.5||-122 45 Du kan rotera kartnålar och deras etiketter med hjälp av rotationsformatsmodifieraren "ro". Det här är ett antal grader av medurs rotation. Använd ett negativt tal för att rotera motsols. Om du till exempel vill rotera kartnålarna 90 grader medsols och fördubbla storleken använder du pins=default|ro90|sc2||-122 45 Du kan göra kartnålar och deras etiketter delvis transparenta genom att ange "al"-alfaformatsmodifieraren. Det här är ett tal mellan 0 och 1 som anger knappnålarnas opacitet. Noll gör dem helt transparenta (och inte synliga) och 1 gör dem helt ogenomskinliga (vilket är standard). Om du till exempel bara vill göra kartnålar och deras etiketter till 67 % ogenomskinliga använder du pins=default|al.67||-122 45 Sammanfattning av formatmallsmodifierare Modifierare Description Intervall Al Alfa (opacitet) 0 till 1 an Fäst fästpunkt * co Fäst färg 000000 till FFFFFF La Etikettfästpunkt * Lc Etikettfärg 000000 till FFFFFF ls Etikettstorlek Större än 0 Ro Rotation -360 till 360 Sc Skala Större än 0 X- och Y-koordinaterna kan finnas var som helst inom fästbilden eller en marginal runt den. Marginalstorleken är den minsta stiftbredden och höjden.
style	query		MapImageStyle	Kartformat som ska returneras. Möjliga värden är huvudsakliga och mörka.
view	query		LocalizedMapView	Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa platsen för dina användare och ange sedan parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN. Mer information finns i Vyer som stöds och för att se tillgängliga vyer.
width	query		integer int32	Bredd på den resulterande bilden i bildpunkter. Intervallet är 1 till 8192. Standardvärdet är 512. Det bör inte användas med bbox.
zoom	query		integer int32	Önskad zoomnivå för kartan. Zoomvärdet måste ligga i intervallet: 0–20 (inklusive). Standardvärdet är 12. Mer information finns i Zoomnivåer och Panelrutnät .

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Svar

Name	Typ	Description
200 OK	object	Den här avbildningen returneras från ett lyckat Get Map Static Image-anrop Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

• Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

• Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du skapar en Azure Maps resurs via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de har utfärdats för.

För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst för Azure Maps REST-API:er där den här nyckeln kan lagras på ett säkert sätt.

Type: apiKey
In: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Successful Static Image Request

Sample Request

HTTP

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

Sample Response

Status code:

200

Content-Type: image/png

Response Body

"{file}"

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
LocalizedMapView	Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa platsen för dina användare och ange sedan parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN. Mer information finns i Vyer som stöds och för att se tillgängliga vyer.
MapImageStyle	Kartformat som ska returneras. Möjliga värden är huvudsakliga och mörka.
RasterTileFormat	Önskat format för svaret. Möjligt värde: png.
StaticMapLayer	Kartlager begärs. Om lagret är inställt på etiketter eller hybrid ska formatet vara png.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

LocalizedMapView

Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa platsen för dina användare och ange sedan parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN.

Mer information finns i Vyer som stöds och för att se tillgängliga vyer.

Name	Typ	Description
AE	string	Förenade Arabemiraten (arabisk vy)
AR	string	Argentina (argentinsk vy)
Auto	string	Returnera kartdata baserat på IP-adressen för begäran.
BH	string	Bahrain (arabisk vy)
IN	string	Indien (indisk vy)
IQ	string	Irak (arabisk vy)
JO	string	Jordanien (arabisk vy)
KW	string	Kuwait (arabisk vy)
LB	string	Libanon (arabisk vy)
MA	string	Marocko (marockansk vy)
OM	string	Oman (arabisk vy)
PK	string	Pakistan (pakistansk vy)
PS	string	Palestinska myndigheten (arabisk vy)
QA	string	Qatar (arabisk vy)
SA	string	Saudiarabien (arabisk vy)
SY	string	Syrien (arabisk vy)
Unified	string	Enhetlig vy (andra)
YE	string	Jemen (arabisk vy)

MapImageStyle

Kartformat som ska returneras. Möjliga värden är huvudsakliga och mörka.

Name	Typ	Description
dark	string	Mörkgrå version av Azure Maps huvudformat
main	string	Azure Maps huvudformat

RasterTileFormat

Önskat format för svaret. Möjligt värde: png.

Name	Typ	Description
png	string	En bild i png-format. Stöder zoomnivåer 0 till och med 18.

StaticMapLayer

Kartlager begärs. Om lagret är inställt på etiketter eller hybrid ska formatet vara png.

Name	Typ	Description
basic	string	Returnerar en bild som innehåller alla kartfunktioner, inklusive polygoner, kantlinjer, vägar och etiketter.
hybrid	string	Returnerar en bild som innehåller kantlinjer, vägar och etiketter och kan läggas över på andra paneler (till exempel satellitbilder) för att skapa hybridpaneler.
labels	string	Returnerar en bild av bara kartans etikettinformation.