Tileset - Get

Odwołanie

Service:: Maps Creator

API Version:: 2023-03-01-preview

Użyj polecenia , aby uzyskać szczegóły zestawu kafelków.

Prześlij żądanie get

Interfejs Get API to żądanie HTTP GET używane do pobierania szczegółów zestawu kafelków.

GET https://{geography}.atlas.microsoft.com/tilesets/{tilesetId}?api-version=2023-03-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
geography	path	True	string	Ten parametr określa, gdzie znajduje się zasób Azure Maps Creator. Prawidłowe wartości to my i eu.
tilesetId	path	True	string	Identyfikator zestawu kafelków
api-version	query	True	string	Numer wersji interfejsu API Azure Maps.

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	Tileset	Pomyślnie ukończono żądanie zestawu kafelków. Treść odpowiedzi zawiera listę wszystkich zestawów kafelków.
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth2 usługi Azure Active Directory . 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 usługi Azure Active Directory. * 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.

Obecnie usługa Azure Active Directory w wersji 1.0 lub 2.0 obsługuje konta służbowe, szkolne i gości, ale nie obsługują kont osobistych.

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

Gets the details for a single tileset

Sample Request

HTTP

GET https://us.atlas.microsoft.com/tilesets/{tilesetId}?api-version=2023-03-01-preview

Sample Response

Status code:: 200

{
  "tilesetId": "{tilesetId}",
  "datasetId": "{datasetId}",
  "description": "My first tileset",
  "minZoom": 16,
  "maxZoom": 18,
  "bbox": [
    -122.13595,
    47.636524,
    -122.1329,
    47.637525
  ]
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
Feature	Konfiguracja funkcji dla konfiguracji zestawu kafelków.
LayerObject	Obiekt warstwy dla konfiguracji zestawu kafelków.
Tileset	Szczegółowe informacje dotyczące danych.
TilesetConfiguration	Pola konfiguracji zestawu kafelków najwyższego poziomu. Konfiguracja zestawu kafelków to obiekt JSON, który musi zawierać następujące pola najwyższego poziomu:

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.

Feature

Konfiguracja funkcji dla konfiguracji zestawu kafelków.

Nazwa	Typ	Opis
featureClasses	string[]	Lista klas funkcji, które będą używane do kompilowania warstwy. Prawidłowe klasy funkcji można znaleźć w definicji ontologii. Na przykład ontologia obiektu
filter	object	Usuwa funkcje, które nie pasują do wzorca. Zapoznaj się z wyrażeniem filtru MapLibre

LayerObject

Obiekt warstwy dla konfiguracji zestawu kafelków.

Nazwa	Typ	Opis
features	Feature	Określa klasy i filtry funkcji.
maxZoom	integer	Najwyższy poziom powiększenia dla warstwy do skompilowania.
minZoom	integer	Najniższy poziom powiększenia dla warstwy do skompilowania.

Tileset

Szczegółowe informacje dotyczące danych.

Nazwa	Typ	Opis
bbox	number[]	Pole ograniczenia, w którym znajdują się wszystkie funkcje zestawu kafelków. Używane projekcje — EPSG:3857. Format: "minLon, minLat, maxLon, maxLat".
datasetId	string	Unikatowy identyfikator zestawu danych użyty do utworzenia zestawu kafelków.
defaultMapConfigurationId	string	Domyślny wygenerowany identyfikator konfiguracji mapy dla zestawu kafelków
description	string	Opis obiektu wywołującego podanego podczas tworzenia zestawu kafelków. Maksymalna długość 1024 znaków.
maxZoom	integer	Kafelek najwyższego poziomu powiększenia kafelka wygenerowany dla zestawu kafelków.
minZoom	integer	Kafelek na najniższym poziomie powiększenia kafelka wygenerowany dla zestawu kafelków.
ontology	string	Wersja ontologii tego zestawu danych.
tilesetConfiguration	TilesetConfiguration	Konfiguracja zestawu kafelków używana do kompilowania zestawu kafelków.
tilesetId	string	Unikatowy identyfikator zestawu kafelków dla zestawu kafelków.

TilesetConfiguration

Pola konfiguracji zestawu kafelków najwyższego poziomu. Konfiguracja zestawu kafelków to obiekt JSON, który musi zawierać następujące pola najwyższego poziomu:

Nazwa	Typ	Opis
layers	<string, LayerObject>	Nazwy warstw i ich opcji konfiguracji. Obiekt warstw konfiguracji zawiera pary klucz-wartość kojarzące nazwy warstw kafelków z ich konfiguracją. Dla każdej pary klucz-wartość klucz jest nazwą warstwy, a wartość jest obiektem LayerObject zawierającym konfigurację i opcje dla warstwy. Każda warstwa musi mieć nazwę. Jest to unikatowy identyfikator warstwy danych w ostatnim zestawie kafelków. W każdym zestawie kafelków każda nazwa warstwy musi być unikatowa. Nazwa warstwy musi być ciągiem zawierającym tylko znaki podkreślenia (_) i alfanumeryczne. Odpowiedni obiekt LayerObject dla każdej nazwy warstwy opisuje sposób tworzenia warstwy kafelka wektorowego. Określa klasy funkcji do pobierania danych funkcji, precyzję danych za pomocą poziomów powiększenia oraz sposób przekształcania funkcji i renderowania ich na kafelki.
version	integer	Wersja konfiguracji usługi Azure Maps Tiling, która jest używana przez konfigurację zestawu kafelków. Obecnie dozwolona jest tylko wersja 1. Użycie dowolnej wersji innej bieżącej wersji lub poprzedniej wersji spowoduje wystąpienie błędu.

Share via