Render - Get Map Image

Service:

Maps

API Version:

1.0

Służy do renderowania obrazu prostokątnego zdefiniowanego przez użytkownika zawierającego sekcję mapy przy użyciu poziomu powiększenia z zakresu od 0 do 20.

Uwaga

wycofanie usługi renderowania w wersji 1 Azure Maps

Usługa Azure Maps Render v1 jest teraz przestarzała i zostanie wycofana w dniu 9.17.26. Aby uniknąć przerw w działaniu usługi, wszystkie wywołania interfejsu API renderowania w wersji 1 muszą zostać zaktualizowane w celu korzystania z interfejsu API renderowania w wersji 2 przez 9/17/26.

Obsługiwany zakres rozdzielczości obrazu mapy to od 1x1 do 8192x8192. Jeśli decydujesz, kiedy używasz usługi obrazów statycznych za pośrednictwem usługi kafelka mapy, warto rozważyć sposób interakcji z renderowaną mapą. Jeśli zawartość mapy będzie stosunkowo niezmieniająca, mapa statyczna jest dobrym wyborem. Jeśli chcesz obsługiwać wiele powiększania, przesuwania i zmieniania zawartości mapy, usługa kafelka mapy byłaby lepszym wyborem.

Usługa udostępnia również funkcję kompozycji obrazów, aby uzyskać obraz statyczny z powrotem z dodatkowymi danymi, takimi jak; wypychania i nakładki geometryczne z następującymi możliwościami gen1 S0, S1 i Gen2.

W usłudze Gen1 S0 można wykonywać następujące czynności:

• Renderowanie do 5 wypychań określonych w żądaniu
• Podaj jeden obraz niestandardowy dla przypiętych numerów PIN w żądaniu
• Dodawanie etykiet do przypięć

W usłudze Gen1 S1 i Gen2 można wykonywać następujące czynności:

• Renderowanie wypychań przez usługę Azure Maps Data Service
• Określanie wielu stylów wypychania
• Renderuj typy geometrii okręgu, wielolinii i wielokąta.
• Renderowanie obsługiwanych typów geometrii GeoJSON przekazanych za pośrednictwem usługi Azure Maps Data Service

Aby zapoznać się ze szczegółowymi przykładami, zobacz przewodnik Renderowanie danych niestandardowych na mapie rasterowej.

Uwaga : do interfejsu API należy podać parametr środkowy lub bbox .

Obsługiwane zakresy Lat i Lon w przypadku używania parametru bbox są następujące:

Poziom powiększenia	Maksymalny zakres wartości Lon	Maksymalny zakres lat
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

With optional parameters:

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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	RasterTileFormat	Żądany format odpowiedzi. Możliwa wartość: png.
api-version	query	True	string	Numer wersji interfejsu API Azure Maps.
bbox	query		number[]	Obwiedni. Używane projekcje — EPSG:3857. Format: 'minLon, minLat, maxLon, maxLat'. Uwaga: bbox lub środek są wymaganymi parametrami. Wzajemnie się wykluczają. Nie należy jej używać z wysokością ani szerokością. Maksymalna dozwolona liczba zakresów dla wartości Lat i Lon jest definiowana dla każdego poziomu powiększenia w tabeli w górnej części tej strony.
center	query		number[]	Współrzędne punktu środkowego. Format: 'lon,lat'. Używane projekcje EPSG:3857. Zakres długości geograficznej: -180 do 180. Zakres szerokości geograficznej: od -85 do 85. Uwaga: środkowe lub skrzynka odbiorcza są wymaganymi parametrami. Wzajemnie się wykluczają.
height	query		integer int32	Wysokość wynikowego obrazu w pikselach. Zakres wynosi od 1 do 8192. Wartość domyślna to 512. Nie należy go używać z bbox.
language	query		string	Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Gdy dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki .
layer	query		StaticMapLayer	Zażądano warstwy mapy. Jeśli warstwa jest ustawiona na etykiety lub hybrydę, format powinien mieć format png.
path	query		string[]	Styl i lokalizacje ścieżki. Ten parametr umożliwia opcjonalne dodawanie linii, wielokątów lub okręgów do obrazu. Styl ścieżki opisuje wygląd linii i wypełnienia. (Pamiętaj, aby poprawnie kodować wartości adresu URL tego parametru, ponieważ będzie zawierać zastrzeżone znaki, takie jak potoki i znaki interpunkcyjne). Parametr ścieżki jest obsługiwany w jednostce SKU konta Azure Maps począwszy od S1. Wiele wystąpień parametru ścieżki umożliwia określenie wielu geometrii przy użyciu ich stylów. Liczba parametrów na żądanie jest ograniczona do 10, a liczba lokalizacji jest ograniczona do 100 na ścieżkę. Aby renderować okrąg o promieniu 100 metrów i punkt środkowy na szerokości geograficznej 45°N i długości geograficznej 122°W przy użyciu stylu domyślnego, dodaj parametr querystring path=ra100||-122 45 Należy pamiętać, że długość geograficzna jest wcześniejsza niż szerokość geograficzna. Po kodowaniu adresu URL będzie to wyglądać następująco: path=ra100%7C%7C-122+45 Wszystkie przykłady w tym miejscu pokazują parametr ścieżki bez kodowania adresu URL, aby uzyskać jasność. Aby renderować linię, oddziel każdą lokalizację znakiem potoku. Na przykład użyj polecenia path=||-122 45|-119.5 43.2|-121.67 47.12 Aby renderować wielokąt, ostatnia lokalizacja musi być równa lokalizacji początkowej. Na przykład użyj polecenia path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45 Wartości długości geograficznej i szerokości geograficznej dla lokalizacji linii i wielokątów mogą mieścić się w zakresie od -360 do 360, aby umożliwić renderowanie geometrii przekraczających anty-agonię. Modyfikatory stylu Wygląd ścieżki można zmodyfikować, dodając modyfikatory stylu. Są one dodawane przed lokalizacjami. Modyfikatory stylów mają dwie litery. Te skrócone nazwy są używane do zmniejszenia długości adresu URL. Aby zmienić kolor konturu, użyj modyfikatora stylu "lc" i określ kolor przy użyciu formatu koloru HTML/CSS RGB, który jest sześciocyfrową liczbą szesnastkową (formularz trzycyfrowy nie jest obsługiwany). Aby na przykład użyć głębokiego różowego koloru, który należy określić jako #FF1493 w css, użyj polecenia path=lcFF1493||-122 45|-119.5 43.2 W celu utworzenia bardziej złożonego stylu wizualnego można połączyć wiele modyfikatorów stylów. 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 Pobieranie lokalizacji ścieżek z usługi Azure Maps Data Storage Dla wszystkich jednostek SKU konta Azure Maps innych niż S0 można uzyskać informacje o lokalizacji ścieżki z usługi Azure Maps Data Storage. Po przekazaniu dokumentu GeoJSON zawierającego lokalizacje ścieżki usługa Data Storage zwraca unikatowy identyfikator danych (UDID), którego można użyć do odwołwania się do danych w parametrze path. Aby użyć geometrii punktu z przekazanego dokumentu GeoJSON jako lokalizacji ścieżki, określ identyfikator UDID w sekcji lokalizacji parametru ścieżki. Na przykład path=||udid-29dc105a-dee7-409f-a3f9-22b066ae4713 Zwróć uwagę, że nie można mieszać lokalizacji ścieżki z magazynu danych z lokalizacjami określonymi w parametrze ścieżki. Podsumowanie modyfikatora stylu Modyfikator Opis Zakres Lc Kolor linii Od 000000 do FFFFFF Fc Kolor wypełnienia Od 000000 do FFFFFF La Linia alfa (nieprzezroczystość) Od 0 do 1 Fa Wypełnienie alfa (nieprzezroczystość) Od 0 do 1 Lw Szerokość linii Większe niż 0 Ra Promień okręgu (mierniki) Większe niż 0
pins	query		string[]	Styl i wystąpienia wypychania. Użyj tego parametru, aby opcjonalnie dodać pinezki pushpin do obrazu. Styl wypychania opisuje wygląd przypięć, a wystąpienia określają współrzędne pchania i opcjonalne etykiety dla każdego pinezki. (Pamiętaj, aby poprawnie kodować wartości adresu URL tego parametru, ponieważ będzie zawierać zastrzeżone znaki, takie jak potoki i znaki interpunkcyjne). Jednostka SKU konta Azure Maps S0 obsługuje tylko jedno wystąpienie parametru pins. Inne jednostki SKU umożliwiają określenie wielu stylów przypinania wielu wystąpień parametru pin. Aby renderować pchanie o szerokości geograficznej 45°N i długości geograficznej 122°W przy użyciu domyślnego wbudowanego stylu wypychania, dodaj parametr ciągu zapytania pins=default||-122 45 Należy pamiętać, że długość geograficzna przypada przed szerokością geograficzną. Po kodowaniu adresu URL będzie to wyglądać następująco: pins=default%7C%7C-122+45 Wszystkie przykłady w tym miejscu pokazują parametr pins bez kodowania adresu URL, aby uzyskać czytelność. Aby renderować pinezkę w wielu lokalizacjach, należy oddzielić każdą lokalizację znakiem potoku. Na przykład użyj polecenia pins=default||-122 45|-119.5 43.2|-121.67 47.12 Jednostka SKU konta Azure Maps S0 zezwala tylko na pięć wypychań. Inne jednostki SKU konta nie mają tego ograniczenia. Modyfikatory stylów Wygląd pinezek można zmodyfikować, dodając modyfikatory stylów. Są one dodawane po stylu, ale przed lokalizacjami i etykietami. Modyfikatory stylów mają nazwę dwuliterową. Te skrócone nazwy są używane do zmniejszenia długości adresu URL. Aby zmienić kolor pinezki, użyj modyfikatora stylu "co" i określ kolor przy użyciu formatu koloru HTML/CSS RGB, który jest sześciocyfrową liczbą szesnastkową (formularz trzycyfrowy nie jest obsługiwany). Aby na przykład użyć głębokiego różowego koloru, który określisz jako #FF1493 w arkuszu CSS, użyj polecenia pins=default|coFF1493||-122 45 Etykiety wypychania Aby dodać etykietę do przypięć, umieść etykietę w pojedynczych cudzysłowach tuż przed współrzędnymi. Aby na przykład oznaczyć trzy pinezki z wartościami "1", "2" i "3", użyj polecenia pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12 Istnieje wbudowany styl wypychania o nazwie "none", który nie wyświetla obrazu pushpin. Możesz użyć tej opcji, jeśli chcesz wyświetlić etykiety bez żadnego obrazu pinezki. Na przykład pins=none||'A'-122 45|'B'-119.5 43.2 Aby zmienić kolor etykiet pushpin, użyj modyfikatora koloru etykiety "lc". Aby na przykład użyć różowych szpilek z czarnymi etykietami, użyj polecenia pins=default|coFF1493|lc000000||-122 45 Aby zmienić rozmiar etykiet, użyj modyfikatora stylu etykiety "ls". Rozmiar etykiety reprezentuje przybliżoną wysokość tekstu etykiety w pikselach. Aby na przykład zwiększyć rozmiar etykiety do 12, użyj polecenia pins=default|ls12||'A'-122 45|'B'-119 43 Etykiety są wyśrodkowane na pchnięciu "kotwica etykiety". Lokalizacja zakotwiczenia jest wstępnie zdefiniowana dla wbudowanych wypychań i znajduje się w górnej części niestandardowych szpilek (zobacz poniżej). Aby zastąpić kotwicę etykiety, użyj modyfikatora stylu "la" i podaj współrzędne X i Y pikseli dla kotwicy. Te współrzędne są względne względem lewego górnego rogu obrazu wypychania. Dodatnie wartości X przenoszą kotwicę po prawej stronie, a dodatnie wartości Y przenoszą kotwicę w dół. Aby na przykład umieścić etykietę kotwicę 10 pikseli w prawo i 4 piksele powyżej lewego górnego rogu obrazu wypychania, użyj polecenia pins=default|la10 -4||'A'-122 45|'B'-119 43 Niestandardowe szpilki Aby użyć niestandardowego obrazu pushpin, użyj słowa "custom" jako nazwy stylu pinezki, a następnie określ adres URL po informacjach o lokalizacji i etykiecie. Użyj dwóch znaków potoku, aby wskazać, że skończysz określać lokalizacje i uruchamiać adres URL. Na przykład pins=custom||-122 45||http://contoso.com/pushpins/red.png Po kodowaniu adresu URL będzie to wyglądać następująco: pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png Domyślnie niestandardowe obrazy pushpin są rysowane na współrzędnych pinezki. Zwykle nie jest to idealne rozwiązanie, ponieważ zaciemnia lokalizację, którą próbujesz wyróżnić. Aby zastąpić lokalizację zakotwiczenia obrazu pinezki, użyj modyfikatora stylu "an". Używa to tego samego formatu co modyfikator stylu kotwicy etykiety "la". Jeśli na przykład niestandardowy obraz pinezki zawiera końcówkę pinezki w lewym górnym rogu obrazu, możesz ustawić kotwicę na to miejsce, używając polecenia pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png Uwaga: Jeśli używasz modyfikatora kolorów "co" z niestandardowym obrazem pushpin, określony kolor zastąpi kanały RGB pikseli na obrazie, ale pozostawi kanał alfa (nieprzezroczystość) bez zmian. Zwykle odbywa się to tylko przy użyciu obrazu niestandardowego w kolorze stałym. Pobieranie wypychań z magazynu danych Azure Maps Dla wszystkich jednostek SKU konta Azure Maps innych niż S0 można uzyskać informacje o lokalizacji wypychania z usługi Azure Maps Data Storage. Po przekazaniu dokumentu GeoJSON zawierającego lokalizacje przypinania usługa Data Storage zwraca unikatowy identyfikator danych (UDID), którego można użyć do odwołwania się do danych w parametrze pins. Aby użyć geometrii punktu z przekazanego dokumentu GeoJSON jako lokalizacji pinezki, określ identyfikator UDID w sekcji lokalizacji parametru pins. Na przykład pins=default||udid-29dc105a-dee7-409f-a3f9-22b066ae4713 Należy pamiętać, że będą używane tylko geometrie punktów i wielopunktów z kolekcji geometrycznych oraz geometria punktów z funkcji. Geometria linii i wielokąta zostanie zignorowana. Jeśli punkt pochodzi z funkcji, a funkcja ma właściwość ciągu o nazwie "label", wartość tej właściwości będzie używana jako etykieta pinezki. Możesz mieszać lokalizacje przypinania z magazynu danych i lokalizacji pin określonych w parametrze pins. Dowolna z rozdzielonych potokami lokalizacji wyprowadzenia może być długością geograficzną i szerokością geograficzną lub identyfikatorem UDID. Na przykład pins=default||-122 45|udid-29dc105a-dee7-409f-a3f9-22b066ae4713|-119 43 Skalowanie, rotacja i nieprzezroczystość Przy użyciu modyfikatora stylu skalowania "sc" można tworzyć szpilki i ich etykiety większe lub mniejsze. Jest to wartość większa niż zero. Wartość 1 to standardowa skala. Wartości większe niż 1 sprawią, że pinezki będą większe, a wartości mniejsze niż 1 będą mniejsze. Aby na przykład narysować szpilki 50% większe niż normalnie, użyj polecenia pins=default|sc1.5||-122 45 Przy użyciu modyfikatora stylu rotacji "ro" można obracać szpilki i ich etykiety. Jest to wiele stopni obrotu zgodnie z ruchem wskazówek zegara. Użyj liczby ujemnej, aby obracać licznik zgodnie z ruchem wskazówek zegara. Na przykład, aby obracać szpilki 90 stopni w ruchem wskazówek zegara i podwoić ich rozmiar, użyj pins=default|ro90|sc2||-122 45 Można tworzyć szpilki i ich etykiety częściowo przezroczyste, określając modyfikator stylu alfa "al". Jest to liczba z zakresu od 0 do 1 wskazująca nieprzezroczystość szpilek. Zero sprawia, że są całkowicie przezroczyste (i niewidoczne), a 1 sprawia, że są całkowicie nieprzezroczyste (co jest wartością domyślną). Aby na przykład tworzyć szpilki pushpin i ich etykiety tylko 67% nieprzezroczyste, użyj polecenia pins=default|al.67||-122 45 Podsumowanie modyfikatora stylu Modyfikator Opis Zakres Al Alfa (nieprzezroczystość) Od 0 do 1 an Przypinanie kotwicy * co Kolor pinezki 000000 do FFFFFF La Kotwica etykiety * Lc Kolor etykiety Od 000000 do FFFFFF ls Rozmiar etykiety Większe niż 0 Ro Wymiana -360 do 360 Sc Skalowanie Większe niż 0 Współrzędne X i Y mogą znajdować się w dowolnym miejscu w obrębie obrazu pinezki lub marginesu wokół niego. Rozmiar marginesu to minimalna szerokość i wysokość pinezki.
style	query		MapImageStyle	Styl mapy, który ma zostać zwrócony. Możliwe wartości są główne i ciemne.
view	query		LocalizedMapView	Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.
width	query		integer int32	Szerokość obrazu wynikowego w pikselach. Zakres wynosi od 1 do 8192. Wartość domyślna to 512. Nie należy go używać z bbox.
zoom	query		integer int32	Żądany poziom powiększenia mapy. Wartość powiększenia musi należeć do zakresu: 0–20 (włącznie). Wartość domyślna to 12. Aby uzyskać szczegółowe informacje, zobacz Poziomy powiększenia i Siatka kafelków .

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	object	Ten obraz jest zwracany z pomyślnego wywołania pobierz statyczny obraz mapy Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth 2.0 Microsoft Entra. W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

• Ta definicja zabezpieczeń wymaga użycia nagłówkax-ms-client-id, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje Tożsamość Microsoft Entra. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

• Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.

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

Scopes

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST Azure Maps w celu bezpiecznego przechowywania klucza.

Type: apiKey
In: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Type: apiKey
In: header

Przykłady

Successful Static Image Request

Sample Request

HTTP

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

Sample Response

Status code:

200

Content-Type: image/png

Response Body

"{file}"

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
LocalizedMapView	Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.
MapImageStyle	Styl mapy, który ma zostać zwrócony. Możliwe wartości są główne i ciemne.
RasterTileFormat	Żądany format odpowiedzi. Możliwa wartość: png.
StaticMapLayer	Zażądano warstwy mapy. Jeśli warstwa jest ustawiona na etykiety lub hybrydę, format powinien być png.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

LocalizedMapView

Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN.

Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.

Nazwa	Typ	Opis
AE	string	Zjednoczone Emiraty Arabskie (widok arabski)
AR	string	Argentyna (widok argentyński)
Auto	string	Zwróć dane mapy na podstawie adresu IP żądania.
BH	string	Bahrajn (widok arabski)
IN	string	Indie (Widok indyjski)
IQ	string	Irak (widok arabski)
JO	string	Jordania (widok arabski)
KW	string	Kuwejt (widok arabski)
LB	string	Liban (widok arabski)
MA	string	Maroko (widok marokański)
OM	string	Oman (widok arabski)
PK	string	Pakistan (Widok pakistanu)
PS	string	Autonomia Palestyńska (widok arabski)
QA	string	Katar (widok arabski)
SA	string	Arabia Saudyjska (widok arabski)
SY	string	Syria (widok arabski)
Unified	string	Ujednolicony widok (inne)
YE	string	Jemen (widok arabski)

MapImageStyle

Styl mapy, który ma zostać zwrócony. Możliwe wartości są główne i ciemne.

Nazwa	Typ	Opis
dark	string	Ciemna szara wersja głównego stylu Azure Maps
main	string	główny styl Azure Maps

RasterTileFormat

Żądany format odpowiedzi. Możliwa wartość: png.

Nazwa	Typ	Opis
png	string	Obraz w formacie png. Obsługuje poziomy powiększenia od 0 do 18.

StaticMapLayer

Zażądano warstwy mapy. Jeśli warstwa jest ustawiona na etykiety lub hybrydę, format powinien być png.

Nazwa	Typ	Opis
basic	string	Zwraca obraz zawierający wszystkie funkcje mapy, w tym wielokąty, obramowania, drogi i etykiety.
hybrid	string	Zwraca obraz zawierający obramowania, drogi i etykiety i może być nakładany na inne kafelki (takie jak obrazy satelitarne) w celu utworzenia kafelków hybrydowych.
labels	string	Zwraca obraz tylko informacji o etykiecie mapy.