Render - Get Map Tileset
Służy do pobierania metadanych dla zestawu kafelków.
Interfejs API pobierania zestawu 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. aktualna wersja to 2024-04-01. |
|
tileset
|
query | True |
Zestaw kafelków to kolekcja danych rasterowych lub wektorowych podzielonych na jednolitą siatkę kafelków kwadratowych na ustawionych poziomach powiększenia. Każdy zestaw kafelków ma kafelkówetId do użycia podczas wprowadzania żądań. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczone przez usługę Azure Maps. Na przykład microsoft.base. |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-id |
string |
Wskazuje konto przeznaczone do użycia z modelem zabezpieczeń Microsoft Entra ID. Ten unikatowy identyfikator konta Azure Maps można uzyskać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Wystąpił nieoczekiwany błąd. |
Zabezpieczenia
AADToken
Są to przepływy Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą 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 koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera 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.
Notatki
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-idw celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps.
Authorization URL jest specyficzna 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 na podstawie 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 Web SDK 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 Microsoft identity platform overview.
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 zasobów 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.
Za pomocą 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 serwer-serwer 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 List SAS na 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 AZURE SDK lub interfejsów API REST.
Dzięki temu tokenowi 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 SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.
Typ:
apiKey
W:
header
Przykłady
Successful Tileset Request
Przykładowe żądanie
GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base
Przykładowa odpowiedź
{
"tilejson": "2.2.0",
"version": "1.0.0",
"attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">©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 |
|---|---|
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Odpowiedź na błąd |
|
Map |
Metadane zestawu kafelków w formacie TileJSON. |
| TilesetID |
Zestaw kafelków to kolekcja danych rasterowych lub wektorowych podzielonych na jednolitą siatkę kafelków kwadratowych na ustawionych poziomach powiększenia. Każdy zestaw kafelków ma kafelkówetId do użycia podczas wprowadzania żądań. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczone 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 |
Dodatkowe informacje o błędzie. |
|
| code |
string |
Kod błędu. |
| details |
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 |
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 śledzenia XSS lub sygnału nawigacyjnego. |
| bounds |
number[] |
Maksymalny zakres dostępnych kafelków mapy. Ograniczenia MUSZĄ definiować obszar objęty wszystkimi poziomami powiększenia. Granice są reprezentowane w wartościach szerokości geograficznej i długości geograficznej usługi WGS:84 w kolejności: lewa, dolna, prawa, górna. 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 mieścić 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 charakter 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 śledzenia XSS lub sygnału nawigacyjnego. |
| maxzoom |
integer minimum: 0maximum: 30 |
Maksymalny poziom powiększenia. |
| minzoom |
integer minimum: 0maximum: 30 |
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 używany do formatowania danych z siatki na potrzeby interakcji. |
| tilejson |
string pattern: \d+\.\d+\.\d+\w?[\w\d]* |
Opisuje wersję specyfikacji TileJSON zaimplementowaną 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 pattern: \d+\.\d+\.\d+\w?[\w\d]* |
Numer wersji stylu semver.org kafelków zawartych w zestawie kafelków. Po wprowadzeniu zmian między kafelkami wersja pomocnicza MUSI ulec zmianie. |
TilesetID
Zestaw kafelków to kolekcja danych rasterowych lub wektorowych podzielonych na jednolitą siatkę kafelków kwadratowych na ustawionych poziomach powiększenia. Każdy zestaw kafelków ma kafelkówetId do użycia podczas wprowadzania żądań. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczone przez usługę Azure Maps. Na przykład microsoft.base.
| Wartość | Opis |
|---|---|
| microsoft.base |
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: wektorowy (pbf). |
| microsoft.base.labels |
Wyświetla etykiety dla dróg, naturalnych i sztucznych cech na kafelku wektorowym. Obsługuje poziomy powiększenia od 0 do 22. Format: wektorowy (pbf). |
| microsoft.base.hybrid |
Wyświetla dane dróg, granic i etykiet w kafelku wektorowym. Obsługuje poziomy powiększenia od 0 do 22. Format: wektorowy (pbf). |
| microsoft.terra.main |
Cieniowana ulga i warstwy terra. Obsługuje poziomy powiększenia od 0 do 6. Format: rastrowy (png). |
| microsoft.base.road |
Wszystkie warstwy z naszym głównym stylem. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.base.darkgrey |
Wszystkie warstwy z naszym ciemnoszarym stylem. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.base.labels.road |
Oznacz dane w naszym głównym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.base.labels.darkgrey |
Oznacz dane w naszym ciemnoszarym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.base.hybrid.road |
Dane dotyczące dróg, granic i etykiet w naszym głównym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.base.hybrid.darkgrey |
Dane dotyczące dróg, granic i etykiet w naszym ciemnoszarym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.imagery |
Połączenie zdjęć satelitarnych lub lotniczych. Dostępne tylko w jednostkach SKU cenowych S1 i G2. Obsługuje poziomy powiększenia od 1 do 19. Format: rastrowy (png). |
| microsoft.weather.radar.main |
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 zasięgu usługi Pogoda Azure Maps, zobacz Zasięg usług pogodowych Azure Maps. Aby uzyskać więcej informacji na temat danych radarowych, zobacz Usługi pogodowe w Azure Maps. Obsługuje poziomy powiększenia od 0 do 15. Format: rastrowy (png). |
| microsoft.weather.infrared.main |
Kafelki na podczerwonej pogodzie. Najnowsze obrazy satelitarne podczerwieni pokazują chmury według ich temperatury. Aby uzyskać więcej informacji, zobacz Zasięg usług pogodowych Azure Maps. Aby uzyskać więcej informacji na temat zwróconych danych satelitarnych, zobacz Usługi pogodowe w Azure Maps. Obsługuje poziomy powiększenia od 0 do 15. Format: rastrowy (png). |
| microsoft.traffic.absolute |
bezwzględne kafelki ruchu w wektorze |
| microsoft.traffic.absolute.main |
bezwzględne kafelki ruchu w rasterze w naszym głównym stylu. |
| microsoft.traffic.relative |
kafelki ruchu względnego w wektorze |
| microsoft.traffic.relative.main |
kafelki ruchu względnego w rasterze w naszym głównym stylu. |
| microsoft.traffic.relative.dark |
względne kafelki ruchu w rasterze w naszym ciemnym stylu. |
| microsoft.traffic.delay |
kafelki ruchu w wektorze |
| microsoft.traffic.delay.main |
kafelki ruchu w rasterze w naszym głównym stylu |
| microsoft.traffic.reduced.main |
zmniejszenie liczby kafelków ruchu w rasterze w naszym głównym stylu |
| microsoft.traffic.incident |
kafelki incydentów w wektorze |