Render - Get Map Tileset

Reference

Služba:: Maps

Verze rozhraní API:: 2024-04-01

Slouží k získání metadat pro sadu dlaždic.

Rozhraní API Get Map Tileset umožňuje uživatelům vyžadovat metadata pro sadu dlaždic.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
api-version	query	True	string	Číslo verze rozhraní API služby Azure Maps Aktuální verze je 2024-04-01.
tilesetId	query	True	TilesetID	Sada dlaždic je kolekce rastrových nebo vektorových dat rozdělených do jednotné mřížky čtvercových dlaždic s přednastavenými úrovněmi přiblížení. Každá sada dlaždic má id sady dlaždic , které se použije při vytváření požadavků. Id sady dlaždic pro sady dlaždic vytvořené pomocí Azure Maps Creatoru se generuje prostřednictvím rozhraní API pro vytváření sad dlaždic. Sady dlaždic připravené k použití, které poskytuje Azure Maps, jsou uvedené níže. Například microsoft.base.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID v Azure Maps najdete v následujících článcích .

Odpovědi

Name	Typ	Description
200 OK	MapTileset	OK
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra OAuth 2.0 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k rozhraním Azure Maps REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo několika oprávnění k rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení prostředku Azure Maps, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytváření prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace autorizaci pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystavené.

U veřejně vystavených aplikací doporučujeme použít přístup mezi servery k rozhraním REST API služby Azure Maps, kde je možné tento klíč bezpečně uložit.

Typ: apiKey
V: header

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečeným způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.

Typ: apiKey
V: header

Příklady

Successful Tileset Request

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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
  ]
}

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Odpověď na chybu
MapTileset	Metadata pro sadu dlaždic ve formátu TileJSON.
TilesetID	Sada dlaždic je kolekce rastrových nebo vektorových dat rozdělených do jednotné mřížky čtvercových dlaždic s přednastavenými úrovněmi přiblížení. Každá sada dlaždic má id sady dlaždic , které se použije při vytváření požadavků. Id tileetId pro sady dlaždic vytvořené pomocí Azure Maps Creatoru se generuje prostřednictvím rozhraní API pro vytváření sady dlaždic. Sady dlaždic, které jsou připravené k použití, jsou uvedené níže. Například microsoft.base.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

MapTileset

Metadata pro sadu dlaždic ve formátu TileJSON.

Name	Typ	Description
attribution	string	Přiřazení autorských práv, které se má zobrazit na mapě. Implementace se mohou rozhodnout, že to budou považovat za html nebo literálový text. Z bezpečnostních důvodů se ujistěte, že toto pole nelze zneužít jako vektor pro sledování XSS nebo signálu.
bounds	number[]	Maximální rozsah dostupných dlaždic map. Hranice MUSÍ definovat oblast pokrytou všemi úrovněmi přiblížení. Hranice jsou reprezentovány v hodnotách šířky a délky WGS:84 v pořadí vlevo, dole, vpravo, nahoře. Hodnoty můžou být celá čísla nebo čísla s plovoucí desetinou čárkou.
center	number[]	Výchozí umístění sady dlaždic ve tvaru [zeměpisná délka, zeměpisná šířka, lupa]. Úroveň přiblížení MUSÍ být mezi minzoom a maxzoom. Implementace můžou tuto hodnotu použít k nastavení výchozího umístění.
data	string[]	Pole datových souborů ve formátu GeoJSON.
description	string	Textový popis sady dlaždic. Popis může obsahovat jakýkoli právní charakter. Implementace BY NEMĚLY interpretovat popis jako HTML.
grids	string[]	Pole koncových bodů interaktivity.
legend	string	Legenda, která se má zobrazit s mapou. Implementace se mohou rozhodnout, že to budou považovat za html nebo literálový text. Z bezpečnostních důvodů se ujistěte, že toto pole nelze zneužít jako vektor pro sledování XSS nebo signálu.
maxzoom	integer	Maximální úroveň přiblížení.
minzoom	integer	Minimální úroveň přiblížení.
name	string	Název popisující sadu dlaždic. Název může obsahovat jakýkoli právní charakter. Implementace BY NEMĚLY interpretovat název jako HTML.
scheme	string	Výchozí: "xyz". Buď "xyz" nebo "tms". Ovlivňuje směr y souřadnic dlaždic. Předpokládá se profil global-mercator (neboli Spherical Mercator).
template	string	Šablona knír, která se má použít k formátování dat z mřížek pro interakci.
tilejson	string	Popisuje verzi specifikace TileJSON, která je implementována tímto objektem JSON.
tiles	string[]	Pole koncových bodů dlaždic. Pokud je zadáno více koncových bodů, klienti mohou používat libovolnou kombinaci koncových bodů. Všechny koncové body MUSÍ vrátit stejný obsah pro stejnou adresu URL. Pole MUSÍ obsahovat aspoň jeden koncový bod.
version	string	Číslo verze semver.org stylu pro dlaždice obsažené v sadě dlaždic. Při zavedení změn mezi dlaždicemi se musí změnit podverze.

TilesetID

Sada dlaždic je kolekce rastrových nebo vektorových dat rozdělených do jednotné mřížky čtvercových dlaždic s přednastavenými úrovněmi přiblížení. Každá sada dlaždic má id sady dlaždic , které se použije při vytváření požadavků. Id tileetId pro sady dlaždic vytvořené pomocí Azure Maps Creatoru se generuje prostřednictvím rozhraní API pro vytváření sady dlaždic. Sady dlaždic, které jsou připravené k použití, jsou uvedené níže. Například microsoft.base.

Name	Typ	Description
microsoft.base	string	Základní mapa je standardní mapa, která zobrazuje cesty, přirozené a umělé prvky spolu s popisky těchto prvků na vektorové dlaždici. Podporuje úrovně přiblížení 0 až 22. Formát: vector (pbf).
microsoft.base.darkgrey	string	Všechny vrstvy s naším tmavě šedým stylem. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.base.hybrid	string	Zobrazí data cest, hranic a popisků ve vektorové dlaždici. Podporuje úrovně přiblížení 0 až 22. Formát: vector (pbf).
microsoft.base.hybrid.darkgrey	string	Data cest, hranic a popisků v našem tmavě šedém stylu. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.base.hybrid.road	string	Data cest, hranic a popisků v našem hlavním stylu. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.base.labels	string	Zobrazí popisky cest, přírodních a umělých prvků na dlaždici vektoru. Podporuje úrovně přiblížení 0 až 22. Formát: vector (pbf).
microsoft.base.labels.darkgrey	string	Označte data v našem tmavě šedém stylu. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.base.labels.road	string	Označte data v našem hlavním stylu. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.base.road	string	Všechny vrstvy s naším hlavním stylem. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.imagery	string	Kombinace satelitních a leteckých snímků. K dispozici pouze v cenové SKU S1. Podporuje úrovně přiblížení 1 až 19. Formát: rastr (jpeg).
microsoft.terra.main	string	Stínované reliéfní a terra vrstvy. Podporuje úrovně přiblížení 0 až 6. Formát: rastr (png).
microsoft.traffic.absolute	string	dlaždice absolutního provozu ve vektoru
microsoft.traffic.absolute.main	string	absolutní dopravní dlaždice v rastru v našem hlavním stylu.
microsoft.traffic.delay	string	dlaždice provozu ve vektoru
microsoft.traffic.delay.main	string	traffic tile in raster in our main style
microsoft.traffic.incident	string	Dlaždice incidentů ve vektoru
microsoft.traffic.reduced.main	string	dlaždice s omezeným provozem v rastru v našem hlavním stylu
microsoft.traffic.relative	string	dlaždice relativního provozu ve vektoru
microsoft.traffic.relative.dark	string	dlaždice relativního provozu v rastru v našem tmavém stylu.
microsoft.traffic.relative.main	string	dlaždice relativního provozu v rastru v našem hlavním stylu.
microsoft.weather.infrared.main	string	Infračervené dlaždice počasí. Nejnovější infračervené satelitní snímky zobrazují mraky podle jejich teploty. Další informace najdete v tématu Pokrytí meteorologické služby Azure Maps. Další informace o vrácených satelitních datech najdete v tématu Služby počasí v Azure Maps. Podporuje úrovně přiblížení 0 až 15. Formát: rastr (png).
microsoft.weather.radar.main	string	Dlaždice meteorologické radary. Nejnovější snímky meteorologické radary, včetně oblastí s deštěm, sněhem, ledem a smíšenými podmínkami. Další informace o pokrytí služby Počasí služby Azure Maps najdete v tématu Pokrytí meteorologické služby Azure Maps. Další informace o radarových datech najdete v tématu Služby počasí v Azure Maps. Podporuje úrovně přiblížení 0 až 15. Formát: rastr (png).

Sdílet prostřednictvím