Render - Get Map Tile

Služba:

Maps

Verze rozhraní API:

1.0

příkaz slouží k získání dlaždic map ve vektorovém nebo rastrovém formátu, které se obvykle integruje do nového ovládacího prvku mapy nebo sady SDK.

Poznámka

Vyřazení služby Azure Maps Render v1

Služba Azure Maps Render v1 je teď zastaralá a vyřadí se 17. 9. 26. Aby nedošlo k přerušení služeb, bude potřeba do 17. 9. 26 aktualizovat všechna volání rozhraní API vykreslování v1 tak, aby používalo rozhraní API pro vykreslování v2 .

Načte dlaždice map ve vektorovém nebo rastrovém formátu, které se obvykle integruje do nového mapového ovládacího prvku nebo sady SDK. Azure ve výchozím nastavení používá pro ovládací prvek webové mapy dlaždice vektorové mapy (viz Úrovně přiblížení a Mřížka dlaždic).

Poznámka: Dlaždice počasí jsou dostupné jenom prostřednictvím rozhraní API Získat dlaždici mapy verze 2. Doporučujeme začít používat nové rozhraní API Get Map Tile V2.

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}

S volitelnými parametry:

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}&tileSize={tileSize}&language={language}&view={view}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
format	path	True	TileFormat	Požadovaný formát odpovědi Možné hodnoty jsou png & pbf.
api-version	query	True	string	Číslo verze rozhraní API Azure Maps.
layer	query	True	MapTileLayer	Byla požadována vrstva mapy. Možné hodnoty jsou basic, hybrid, labels a terra.
style	query	True	MapTileStyle	Styl mapování, který se má vrátit. Možné hodnoty jsou hlavní, tmavé a shaded_relief.
x	query	True	integer int32	Souřadnice X dlaždice v mřížce přiblížení. Hodnota musí být v rozsahu [0, 2zoom -1]. Podrobnosti najdete v tématech Úrovně přiblížení a Mřížka dlaždic .
y	query	True	integer int32	Souřadnice Y dlaždice v mřížce lupy. Hodnota musí být v rozsahu [0, 2zoom -1]. Podrobnosti najdete v tématech Úrovně přiblížení a Mřížka dlaždic .
zoom	query	True	integer int32	Úroveň přiblížení pro požadovanou dlaždici Podrobnosti najdete v tématech Úrovně přiblížení a Mřížka dlaždic .
language	query		string	Jazyk, ve kterém se mají vrátit výsledky hledání. Měl by být jednou z podporovaných značek jazyka IETF, nerozlišují se malá a velká písmena. Pokud data v zadaném jazyce nejsou pro konkrétní pole k dispozici, použije se výchozí jazyk. Podrobnosti najdete v části Podporované jazyky .
tileSize	query		MapTileSize	Velikost vrácené dlaždice mapy v pixelech.
view	query		LocalizedMapView	Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.

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 Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích.

Odpovědi

Name	Typ	Description
200 OK	object	Tento obrázek se vrátí z úspěšného volání Získat dlaždici mapy. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Hlavičky Content-Type: string
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky 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 Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. 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 více oprávnění k Azure Maps rozhraní REST API.

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í Azure Maps prostředku, 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 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 Microsoft identity platform najdete v přehledu 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 vytvoření účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem může každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.

U veřejně vystavených aplikací doporučujeme pro přístup k Azure Maps rozhraní REST API použít přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím 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 Tile Request

Ukázkový požadavek

HTTP

GET https://atlas.microsoft.com/map/tile/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22

Ukázková odpověď

Stavový kód:

200

Content-Type: image/png

"{file}"

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
LocalizedMapView	Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.
MapTileLayer	Byla požadována vrstva mapy. Možné hodnoty jsou basic, hybrid, labels a terra.
MapTileSize	Velikost vrácené dlaždice mapy v pixelech.
MapTileStyle	Styl mapování, který se má vrátit. Možné hodnoty jsou hlavní, tmavé a shaded_relief.
TileFormat	Požadovaný formát odpovědi Možné hodnoty jsou png & pbf.

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

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

LocalizedMapView

Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN.

Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.

Name	Typ	Description
AE	string	Spojené arabské emiráty (arabské zobrazení)
AR	string	Argentina (argentinský pohled)
Auto	string	Vrátí mapová data na základě IP adresy požadavku.
BH	string	Bahrajn (arabské zobrazení)
IN	string	Indie (indické zobrazení)
IQ	string	Irák (arabské zobrazení)
JO	string	Jordánsko (arabské zobrazení)
KW	string	Kuvajt (arabské zobrazení)
LB	string	Libanon (arabské zobrazení)
MA	string	Maroko (marocké zobrazení)
OM	string	Omán (arabské zobrazení)
PK	string	Pákistán (pákistánské zobrazení)
PS	string	Palestinská samospráva (arabské zobrazení)
QA	string	Katar (arabské zobrazení)
SA	string	Saúdská Arábie (arabské zobrazení)
SY	string	Sýrie (arabské zobrazení)
Unified	string	Sjednocené zobrazení (ostatní)
YE	string	Jemen (arabské zobrazení)

MapTileLayer

Byla požadována vrstva mapy. Možné hodnoty jsou basic, hybrid, labels a terra.

Name	Typ	Description
basic	string	Vrátí dlaždici obsahující všechny prvky mapy včetně mnohoúhelníku, ohraničení, silnic a popisků.
hybrid	string	Vrátí dlaždici obsahující ohraničení, cesty a popisky a může být překrytá na jiných dlaždicích (například satelitních snímků) a vytvářet tak hybridní dlaždice.
labels	string	Vrátí dlaždici pouze s informacemi o popisku mapy.
terra	string	Plátno mapy se stínovanými reliéfní dlaždice. Podporují se úrovně zvětšení 0 až 6 (včetně). Jediným podporovaným formátem TileFormat je Png a k dispozici je pouze Hodnota MapTileSize je 512.

MapTileSize

Velikost vrácené dlaždice mapy v pixelech.

Name	Typ	Description
256	string	Vrátí dlaždici o velikosti 256 × 256 pixelů.
512	string	Vrátí dlaždici o velikosti 512 × 512 pixelů.

MapTileStyle

Styl mapování, který se má vrátit. Možné hodnoty jsou hlavní, tmavé a shaded_relief.

Name	Typ	Description
dark	string	Tmavě šedá verze hlavního stylu Azure Maps. Formát PNG je jediným podporovaným formátem dlaždice.
main	string	Azure Maps hlavní styl
shaded_relief	string	Azure Maps hlavní styl doplněný stínovaným reliéfem. Podporováno vrstvou terra.

TileFormat

Požadovaný formát odpovědi Možné hodnoty jsou png & pbf.

Name	Typ	Description
pbf	string	Vektorová grafika ve formátu pbf. Podporuje úrovně přiblížení 0 až 22.
png	string	Obrázek ve formátu PNG. Podporuje úrovně přiblížení 0 až 18.