Render - Get Map Tileset

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 2024-04-01

Służy do pobierania metadanych dla zestawu kafelków.

Interfejs API pobierania zestawów kafelków mapy umożliwia użytkownikom żądanie metadanych dla zestawu kafelków.

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps. Bieżąca wersja to 2024-04-01.
tilesetId	query	True	TilesetID	Zestaw kafelków to kolekcja danych rasterowych lub wektorów podzielonych na jednolitą siatkę kafelków kwadratowych na wstępnie ustawionych poziomach powiększenia. Każdy zestaw kafelków ma identyfikator kafelków do użycia podczas wysyłania żądań. Element tilesetId dla zestawów kafelków utworzonych przy użyciu twórcy usługi Azure Maps jest generowany za pośrednictwem interfejsu API tworzenia zestawu kafelków. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczane przez usługę Azure Maps. Na przykład microsoft.base.

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ń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń microsoft Entra ID w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	MapTileset	OK
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . 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 usługi Azure Maps. Mechanizmy kontroli dostępu oparte na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów usługi 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 interfejsów API REST usługi Azure Maps.

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łówka x-ms-client-id , aby wskazać, do którego zasobu usługi 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 identyfikatorów entra firmy Microsoft. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu Sdk sieci Web usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Omówienie platformy tożsamości firmy Microsoft.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

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

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia zasobu usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne do konta, dla którego są wystawiane.

W przypadku publicznie uwidocznionych aplikacji naszym zaleceniem jest użycie dostępu serwera do serwera interfejsów API REST usługi Azure Maps, w których ten klucz może być bezpiecznie przechowywany.

Typ: apiKey
W: header

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny 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.

Typ: apiKey
W: header

Przykłady

Successful Tileset Request

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base

Przykładowa odpowiedź

Kod stanu:: 200

{
  "tilejson": "2.2.0",
  "version": "1.0.0",
  "attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">&copy;2022 TomTom</a>",
  "scheme": "xyz",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
  ],
  "minzoom": 0,
  "maxzoom": 22,
  "bounds": [
    -180,
    -90,
    180,
    90
  ]
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
MapTileset	Metadane zestawu kafelków w formacie TileJSON.
TilesetID	Zestaw kafelków to kolekcja danych rasterowych lub wektorów podzielonych na jednolitą siatkę kafelków kwadratowych na wstępnie ustawionych poziomach powiększenia. Każdy zestaw kafelków ma identyfikator kafelków do użycia podczas wysyłania żądań. Element tilesetId dla zestawów kafelków utworzonych przy użyciu twórcy usługi Azure Maps jest generowany za pośrednictwem interfejsu API tworzenia zestawu kafelków. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczane przez usługę Azure Maps. Na przykład microsoft.base.

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.

MapTileset

Metadane zestawu kafelków w formacie TileJSON.

Nazwa	Typ	Opis
attribution	string	Przypisanie praw autorskich do wyświetlania na mapie. Implementacje MOGĄ zdecydować o traktowaniu tego jako tekstu HTML lub literału. Ze względów bezpieczeństwa upewnij się, że to pole nie może być nadużywane jako wektor do śledzenia XSS lub sygnału nawigacyjnego.
bounds	number[]	Maksymalny zakres dostępnych kafelków mapy. Granice MUSZĄ definiować obszar objęty wszystkimi poziomami powiększenia. Granice są reprezentowane w wartościach szerokości i długości geograficznej WGS:84, w kolejności lewej, dolnej, prawej, górnej. Wartości mogą być liczbami całkowitymi lub liczbami zmiennoprzecinkowymi.
center	number[]	Domyślna lokalizacja zestawu kafelków w postaci [długość geograficzna, szerokość geograficzna, powiększenie]. Poziom powiększenia MUSI znajdować się między minzoom i maxzoom. Implementacje mogą użyć tej wartości, aby ustawić lokalizację domyślną.
data	string[]	Tablica plików danych w formacie GeoJSON.
description	string	Opis tekstu zestawu kafelków. Opis może zawierać dowolny znak prawny. Implementacje NIE POWINNY interpretować opisu jako KODU HTML.
grids	string[]	Tablica punktów końcowych interakcyjności.
legend	string	Legenda, która ma być wyświetlana z mapą. Implementacje MOGĄ zdecydować o traktowaniu tego jako tekstu HTML lub literału. Ze względów bezpieczeństwa upewnij się, że to pole nie może być nadużywane jako wektor do śledzenia XSS lub sygnału nawigacyjnego.
maxzoom	integer	Maksymalny poziom powiększenia.
minzoom	integer	Minimalny poziom powiększenia.
name	string	Nazwa opisująca zestaw kafelków. Nazwa może zawierać dowolny znak prawny. Implementacje NIE POWINNY interpretować nazwy jako HTML.
scheme	string	Ustawienie domyślne: "xyz". "xyz" lub "tms". Wpływa na kierunek y współrzędnych kafelka. Zakłada się, że profil global-mercator (aka Spherical Mercator).
template	string	Szablon wąsu, który ma być używany do formatowania danych z siatki na potrzeby interakcji.
tilejson	string	Opisuje wersję specyfikacji TileJSON implementowana przez ten obiekt JSON.
tiles	string[]	Tablica punktów końcowych kafelków. Jeśli określono wiele punktów końcowych, klienci mogą używać dowolnej kombinacji punktów końcowych. Wszystkie punkty końcowe MUSZĄ zwrócić tę samą zawartość dla tego samego adresu URL. Tablica MUSI zawierać co najmniej jeden punkt końcowy.
version	string	Numer wersji stylu semver.org kafelków zawartych w zestawie kafelków. Po wprowadzeniu zmian w kafelkach wersja pomocnicza MUSI ulec zmianie.

TilesetID

Zestaw kafelków to kolekcja danych rasterowych lub wektorów podzielonych na jednolitą siatkę kafelków kwadratowych na wstępnie ustawionych poziomach powiększenia. Każdy zestaw kafelków ma identyfikator kafelków do użycia podczas wysyłania żądań. Element tilesetId dla zestawów kafelków utworzonych przy użyciu twórcy usługi Azure Maps jest generowany za pośrednictwem interfejsu API tworzenia zestawu kafelków. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczane przez usługę Azure Maps. Na przykład microsoft.base.

Nazwa	Typ	Opis
microsoft.base	string	Mapa podstawowa to standardowa mapa przedstawiająca drogi, naturalne i sztuczne funkcje wraz z etykietami dla tych funkcji na kafelku wektorowym. Obsługuje poziomy powiększenia od 0 do 22. Format: vector (pbf).
microsoft.base.darkgrey	string	Wszystkie warstwy z naszym ciemnoszarym stylem. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.base.hybrid	string	Wyświetla dane dotyczące drogi, granicy i etykiety na kafelku wektorowym. Obsługuje poziomy powiększenia od 0 do 22. Format: vector (pbf).
microsoft.base.hybrid.darkgrey	string	Dane dotyczące dróg, granic i etykiet w naszym ciemnoszarym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.base.hybrid.road	string	Dane dotyczące dróg, granic i etykiet w naszym głównym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.base.labels	string	Wyświetla etykiety dróg, naturalnych i sztucznych cech na kafelku wektorowym. Obsługuje poziomy powiększenia od 0 do 22. Format: vector (pbf).
microsoft.base.labels.darkgrey	string	Etykiety danych w naszym ciemnym szarym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.base.labels.road	string	Etykieta danych w naszym głównym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.base.road	string	Wszystkie warstwy z naszym głównym stylem. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.imagery	string	Połączenie zdjęć satelitarnych i lotniczych. Dostępne tylko w jednostce SKU cenowej S1. Obsługuje poziomy powiększenia od 1 do 19. Format: raster (jpeg).
microsoft.terra.main	string	Cieniowana ulga i warstwy terra. Obsługuje poziomy powiększenia od 0 do 6. Format: raster (png).
microsoft.traffic.absolute	string	bezwzględne kafelki ruchu w wektorze
microsoft.traffic.absolute.main	string	bezwzględne kafelki ruchu w rasterze w naszym głównym stylu.
microsoft.traffic.delay	string	kafelki ruchu w wektorze
microsoft.traffic.delay.main	string	kafelki ruchu w rasterze w naszym głównym stylu
microsoft.traffic.incident	string	kafelki incydentu w wektorze
microsoft.traffic.reduced.main	string	zredukowane kafelki ruchu w rasterze w naszym głównym stylu
microsoft.traffic.relative	string	kafelki ruchu względnego w wektorze
microsoft.traffic.relative.dark	string	względne kafelki ruchu w rasterze w naszym ciemnym stylu.
microsoft.traffic.relative.main	string	kafelki ruchu względnego w rasterze w naszym głównym stylu.
microsoft.weather.infrared.main	string	Kafelki na podczerwonej pogodzie. Najnowsze obrazy satelitarne podczerwieni pokazują chmury według ich temperatury. Aby uzyskać więcej informacji, zobacz Pokrycie usług pogodowych w usłudze Azure Maps. Aby uzyskać więcej informacji na temat zwracanych danych satelitarnych, zobacz Weather services in Azure Maps (Usługi pogodowe w usłudze Azure Maps). Obsługuje poziomy powiększenia od 0 do 15. Format: raster (png).
microsoft.weather.radar.main	string	Kafelki radaru pogodowego. Najnowsze obrazy radarów pogodowych, w tym obszary deszczu, śniegu, lodu i mieszanych warunków. Aby uzyskać więcej informacji na temat pokrycia usługi Pogody w usłudze Azure Maps, zobacz Pokrycie usług pogodowych w usłudze Azure Maps. Aby uzyskać więcej informacji na temat danych radarowych, zobacz Usługi pogodowe w usłudze Azure Maps. Obsługuje poziomy powiększenia od 0 do 15. Format: raster (png).

Udostępnij za pośrednictwem