Render V2 - Get Map Tile Preview

Dotyczy: S0 i S1 warstw cenowych.

Interfejs API kafelków mapy pobrania umożliwia użytkownikom żądanie kafelków mapy w formatach wektorowych i rastrowych, które zwykle mają być zintegrowane z kontrolką mapy lub zestawem SDK. Przykładowe kafelki, które mogą być żądane, są Azure Maps kafelków drogowych, kafelków meteorologicznych w czasie rzeczywistym lub kafelków mapy utworzonych przy użyciu Azure Maps Creator. Domyślnie Azure Maps używa kafelków wektorowych dla kontrolki mapy sieci Web (Web SDK) i Android SDK.

GET https://atlas.microsoft.com/map/tile?api-version=2.0&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/map/tile?subscription-key={subscription-key}&api-version=2.0&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

Parametry identyfikatora URI

Name In Required Type Description
api-version
query True
  • string

Numer wersji interfejsu API Azure Maps. Bieżąca wersja to 2,0

tilesetId
query True

Tileset to zbiór danych rastrowych lub wektorowych, które zostały podzielone na jednorodną siatkę kafelków z ustawionymi poziomami powiększenia. Każdy tileset ma tilesetId do użycia podczas tworzenia żądań. TilesetId dla tilesets utworzonych za pomocą twórcy Azure Maps są generowane za pośrednictwem interfejsu API tileset Create. Poniżej wymieniono gotowe do użycia tilesets dostarczone przez Azure Maps. Na przykład Microsoft. Base.

x
query True
  • integer
int32

Współrzędna X kafelka na siatce powiększenia. Wartość musi należeć do zakresu [0, 2 zoom -1].

Aby uzyskać szczegółowe informacje , zobacz poziomy powiększenia i siatka kafelków .

y
query True
  • integer
int32

Współrzędna Y kafelka na siatce powiększenia. Wartość musi należeć do zakresu [0, 2 zoom -1].

Aby uzyskać szczegółowe informacje , zobacz poziomy powiększenia i siatka kafelków .

zoom
query True
  • integer
int32

Poziom powiększenia dla żądanego kafelka. Znajdź poniższą listę TilesetID, aby uzyskać szczegółowe informacje na temat obsługiwanego poziomu powiększenia dla każdego tilesetIdu.

Aby uzyskać szczegółowe informacje , zobacz poziomy powiększenia i siatka kafelków .

language
query
  • string

Język, w którym mają być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Jeśli 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, zapoznaj się z obsługiwanymi językami .

subscription-key
query
  • string

Jeden z kluczy Azure Maps dostarczonych z konta usługi Azure map. Zapoznaj się z tym artykułem , aby uzyskać szczegółowe informacje na temat zarządzania uwierzytelnianiem.

tileSize
query

Rozmiar zwracanego kafelka mapy (w pikselach).

timeStamp
query
  • string

Żądana Data i godzina żądanego kafelka. Ten parametr musi być określony w standardowym formacie daty i godziny (np. 2019-11-14T16:03:00-08:00), zgodnie z definicją ISO 8601. Ten parametr jest obsługiwany tylko wtedy, gdy parametr tilesetId jest ustawiony na jedną z poniższych wartości.

  • Microsoft. Pogoda. infrared. Main: Oferujemy kafelki do 3 godzin w przeszłości. Kafelki są dostępne w 10-minutowych interwałach. Wartość sygnatury czasowej jest zaokrąglana do najbliższego 10-minutowego okresu.
  • Microsoft. Pogoda. radar. Main: Oferujemy kafelki do 1,5 godzin w przeszłości i maksymalnie 2 godziny w przyszłości. Kafelki są dostępne w 5-minutowych interwałach. Zaokrąglimy wartość sygnatury czasowej do najbliższego 5-minutowego okresu.
view
query
  • string

Parametr View określa, który zestaw zawartości z geopolitycznej sporu jest zwracany za pośrednictwem usług Azure Maps, w tym obramowań i etykiet wyświetlanych na mapie. Parametr widoku (określany również jako "parametr regionu użytkownika") będzie pokazywał poprawne mapy dla tego kraju/regionu. Domyślnie parametr View jest ustawiony na wartość "Unified", nawet jeśli nie został zdefiniowany w żądaniu. Jest odpowiedzialny za określenie lokalizacji użytkowników, a następnie ustawienie parametru widoku dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View = Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr widoku w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, włącznie z tymi, które dotyczą mapowania, kraju, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innej firmy, do której użytkownik jest uprawniony do dostępu za pośrednictwem Azure Maps. Przykład: widok = IN.

Zobacz sekcję obsługiwane widoki , aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki.

Nagłówek żądania

Name Required Type Description
x-ms-client-id
  • string

Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń usługi Azure AD. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta Azure Maps płaszczyzny zarządzania. Aby skorzystać z zabezpieczeń usługi Azure AD w Azure Maps zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

Name Type Description
200 OK
  • string

OK

400 Bad Request

Złe żądanie: co najmniej jeden parametr został niepoprawnie określony lub wykluczają się wzajemnie.

401 Unauthorized

Odmowa dostępu z powodu nieprawidłowego klucza subskrypcji lub nieprawidłowy token Azure Active Directory okaziciela. Upewnij się, że podano prawidłowy klucz dla aktywnej subskrypcji platformy Azure i zamapowanego zasobu. W przeciwnym razie Sprawdź nagłówek www-Authenticate dla kodu błędu i opis podanego tokenu okaziciela usługi AAD.

Headers

  • WWW-Authenticate: string
403 Forbidden

Problemy z uprawnieniami, pojemnością lub uwierzytelnianiem.

404 Not Found

Nie znaleziono: nie można znaleźć żądanego zasobu, ale może on być ponownie dostępny w przyszłości.

500 Internal Server Error

Wystąpił błąd podczas przetwarzania żądania. Spróbuj ponownie później.

Zabezpieczenia

azure_auth

Są to Azure Active Directory przepływy OAuth2 . W przypadku sparowania z kontrolą dostępu opartą na rolach na platformie Azure można kontrolować dostęp do Azure Maps interfejsów API REST. Kontrola dostępu oparta na rolach na platformie Azure służy do wyznaczania dostępu do co najmniej jednego Azure Maps konta zasobu lub podzasobów. Do wszystkich użytkowników, grup lub jednostek usługi można udzielić dostępu 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świetlanie pojęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń zapewnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które umożliwiają kontrolę dostępu do określonych interfejsów API i zakresów.

Uwaga

  • Ta definicja zabezpieczeń wymaga użycia x-ms-client-id nagłówka, aby wskazać, który Azure Maps zasób, do którego aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.
  • Authorization URLJest to specyficzne 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 na platformie Azure jest konfigurowana z poziomu 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 Azure Maps Web SDK umożliwia konfigurowanie aplikacji na podstawie konfiguracji w wielu przypadkach użycia.
  • Obecnie obsługiwane są tokeny Azure Active Directory v 1.0 .

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

subscription-key

Jest to klucz współużytkowany, który jest inicjowany podczas tworzenia zasobu Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia platformy Azure lub interfejsów API REST. Przy użyciu tego klucza każda aplikacja ma autoryzację dostępu do wszystkich interfejsów API REST. Inaczej mówiąc, te dane mogą być obecnie traktowane jako klucze główne do konta, dla którego są wystawiane. W przypadku aplikacji publicznie narażonych zaleca się używanie serwera do dostępu do serwera Azure Maps interfejsów API REST, w których ten klucz może być bezpiecznie przechowywany.

Type: apiKey
In: query

Przykłady

GetMapTile

Sample Request

GET https://atlas.microsoft.com/map/tile?subscription-key=[subscription-key]&api-version=2.0&tilesetId=microsoft.base&zoom=6&x=10&y=22

Sample Response

"binary string image"
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definicje

ODataError

Ten obiekt jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

ODataErrorResponse

Ten obiekt odpowiedzi jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

TilesetID

Tileset to zbiór danych rastrowych lub wektorowych, które zostały podzielone na jednorodną siatkę kafelków z ustawionymi poziomami powiększenia. Każdy tileset ma tilesetId do użycia podczas tworzenia żądań. TilesetId dla tilesets utworzonych za pomocą twórcy Azure Maps są generowane za pośrednictwem interfejsu API tileset Create. Poniżej wymieniono gotowe do użycia tilesets dostarczone przez Azure Maps. Na przykład Microsoft. Base.

TileSize

Rozmiar zwracanego kafelka mapy (w pikselach).

ODataError

Ten obiekt jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

Name Type Description
code
  • string

Kod ODataError.

details

Ten obiekt jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

message
  • string

Jeśli jest dostępny, czytelny dla człowieka opis błędu.

target
  • string

Jeśli jest dostępny, obiekt docelowy powoduje błąd.

ODataErrorResponse

Ten obiekt odpowiedzi jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

Name Type Description
error

Ten obiekt jest zwracany, gdy w interfejsie API Maps wystąpi błąd.

TilesetID

Tileset to zbiór danych rastrowych lub wektorowych, które zostały podzielone na jednorodną siatkę kafelków z ustawionymi poziomami powiększenia. Każdy tileset ma tilesetId do użycia podczas tworzenia żądań. TilesetId dla tilesets utworzonych za pomocą twórcy Azure Maps są generowane za pośrednictwem interfejsu API tileset Create. Poniżej wymieniono gotowe do użycia tilesets dostarczone przez Azure Maps. Na przykład Microsoft. Base.

Name Type Description
microsoft.base
  • string

Mapa podstawowa to mapa standardowa, która wyświetla drogi, naturalne i sztuczne funkcje wraz z etykietami tych funkcji w kafelku wektora.

Obsługuje poziomy powiększenia od 0 do 22. Format: Vector (PBF).

microsoft.base.darkgrey
  • string

Wszystkie warstwy z ciemnozielonym stylem szarym.

Obsługuje poziomy powiększenia od 0 do 18. Format: Raster (PNG).

microsoft.base.hybrid
  • string

Wyświetla dane dotyczące dróg, granic i etykiet w kafelku wektora.

Obsługuje poziomy powiększenia od 0 do 22. Format: Vector (PBF).

microsoft.base.hybrid.road
  • string

Dane drogowe, graniczne i etykiety w naszym stylu głównym.

Obsługuje poziomy powiększenia od 0 do 18. Format: Raster (PNG).

microsoft.base.labels
  • string

Wyświetla etykiety dla dróg, naturalnych i sztucznych funkcji w kafelku wektora.

Obsługuje poziomy powiększenia od 0 do 22. Format: Vector (PBF).

microsoft.base.labels.road
  • string

Oznacz dane w naszym stylu głównym.

Obsługuje poziomy powiększenia od 0 do 18. Format: Raster (PNG).

microsoft.base.road
  • string

Wszystkie warstwy z naszym głównym stylem.

Obsługuje poziomy powiększenia od 0 do 18. Format: Raster (PNG).

microsoft.dem
  • string

Kafelki modelu podniesienia uprawnień cyfrowych. Kafelek obrazów w formacie TIFF, w tym dane podniesienia poziomu powierzchni ziemi. Obsługuje tylko poziom powiększenia 13. Format: Raster (TIFF).

microsoft.imagery
  • string

Kombinacja zdjęć satelitarnych i antenowych. Dostępne tylko w jednostce SKU cen S1.

Obsługuje poziomy powiększenia od 1 do 19. Format: Raster (JPEG).

microsoft.terra.main
  • string

Cieniowane i Terra warstwy.

Obsługuje poziomy powiększenia od 0 do 6. Format: Raster (PNG).

microsoft.weather.infrared.main
  • string

Kafelki z przełączaniem do podczerwieni. Najnowsze obrazy satelitarne podczerwieni przedstawiają chmury według ich temperatury. Zobacz Informacje o zapotrzebowaniu dotyczące usługi Azure Maps Pogoda. Aby dowiedzieć się więcej na temat zwróconych danych satelity, zobacz pojęcia pogodowe.

Obsługuje poziomy powiększenia od 0 do 15. Format: Raster (PNG).

microsoft.weather.radar.main
  • string

Kafelki radarowe. Najnowsze obrazy z radaru pogodowego, w tym obszary deszczu, śniegu, lodu i mieszane warunki. Zobacz Informacje o zapotrzebowaniu dotyczące usługi Azure Maps Pogoda. Aby dowiedzieć się więcej o danych radarowych, zobacz pojęcia pogodowe.

Obsługuje poziomy powiększenia od 0 do 15. Format: Raster (PNG).

TileSize

Rozmiar zwracanego kafelka mapy (w pikselach).

Name Type Description
256
  • string

Zwróć kafelek 256 o 256 pikseli. Dostępne dla wszystkich tilesetIds z wyjątkiem

  • Microsoft. Terra. Main
512
  • string

Zwróć kafelek 512 o 512 pikseli. Dostępne dla wszystkich tilesetIds z wyjątkiem

  • Microsoft. Pogoda. radar. Main
  • Microsoft. Pogoda. infrared. Main
  • Microsoft. Base. hybrydowy
  • Microsoft. dem