Render - Get Map Tileset

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

Rozhraní Get Map Tileset API je požadavek HTTP GET , který uživatelům umožňuje vyžadovat metadata pro sadu dlaždic.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
api-version
query True

string

Číslo verze rozhraní API Azure Maps. Aktuální verze je 1. 8. 2022

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 tileetId pro sady dlaždic vytvořené pomocí Azure Maps Creatoru se generuje prostřednictvím rozhraní API sady dlaždic Create. Sady dlaždic předdefinované 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 dá se načíst z rozhraní API účtu Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny 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 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, která se skládá 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 k určitým rozhraním API a oborům.

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. To je možné získat z rozhraní API pro správu map.

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í.

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

Scopes

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

subscription-key

Jedná se o sdílený klíč, který se zřizuje při vytváření 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 klíčem má každá aplikace oprávnění 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 vystaveny.

U veřejně vystavených aplikací doporučujeme používat přístup mezi servery Azure Maps rozhraní REST API, ve kterých lze tento klíč bezpečně uložit.

Type: apiKey
In: 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 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 oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnější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 mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Type: apiKey
In: header

Příklady

Successful Tileset Request

Sample Request

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

Sample Response

{
  "tilejson": "2.2.0",
  "name": "microsoft.core.vector",
  "version": "1.0.0",
  "attribution": "<a data-azure-maps-attribution-dynamic=\"true\" data-azure-maps-attribution-tileset=\"microsoft.core.vector\"></a>",
  "scheme": "xyz",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2.1&tilesetId=microsoft.core.vector&zoom={z}&x={x}&y={y}&language=ngt"
  ],
  "grids": [],
  "data": [],
  "minzoom": 1,
  "maxzoom": 21,
  "bounds": [
    -180,
    -90,
    180,
    90
  ]
}

Definice

Name Description
ErrorAdditionalInfo

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

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Chybová odpověď

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 sady dlaždic pro sady dlaždic vytvořené pomocí Azure Maps Creatoru se generuje prostřednictvím rozhraní API sady dlaždic Create. Sady dlaždic připravené k použití, které Azure Maps, 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

Další typ informací.

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.

MapTileset

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

Name Typ Description
attribution

string

Přiřazení autorských práv, které se zobrazí na mapě. Implementace se mohou rozhodnout, že se s tím budou zacházet jako s html nebo literálovým textem. Z bezpečnostních důvodů se ujistěte, že toto pole nelze zneužít jako vektor pro sledování XSS nebo beacon.

bounds

number[]

Maximální rozsah dostupných dlaždic map. Hranice MUSÍ definovat oblast pokrytou všemi úrovněmi přiblížení. Hranice jsou znázorněny v hodnotách WGS:84 zeměpisná šířka a délka 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 v rozmezí minzoom a maxzoom. Implementace mohou 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 se s tím budou zacházet jako s html nebo literálovým textem. Z bezpečnostních důvodů se ujistěte, že toto pole nelze zneužít jako vektor pro sledování XSS nebo beacon.

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í znak. Implementace BY NEMĚLY interpretovat název jako HTML.

scheme

string

Výchozí hodnota: "xyz". Buď "xyz", nebo "tms". Ovlivňuje směr y souřadnic dlaždice. Předpokládá se profil global-mercator (neboli Spherical Mercator).

template

string

Šablona mustache, která se má použít k formátování dat z mřížky 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 alespoň jeden koncový bod.

version

string

Číslo verze semver.org stylu pro dlaždice obsažené v sadě dlaždic. Při zavedení změn napříč 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 sady dlaždic pro sady dlaždic vytvořené pomocí Azure Maps Creatoru se generuje prostřednictvím rozhraní API sady dlaždic Create. Sady dlaždic připravené k použití, které Azure Maps, 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ů ve vektorové dlaždici.

Podporuje úrovně přiblížení 0 až 22. Formát: vektor (pbf).

microsoft.base.darkgrey

string

Všechny vrstvy v našem tmavě šedém stylu.

Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).

microsoft.base.hybrid

string

Zobrazí data cest, hranic a popisků v dlaždici vektoru.

Podporuje úrovně přiblížení 0 až 22. Formát: vektor (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ů ve vektorové dlaždici.

Podporuje úrovně přiblížení 0 až 22. Formát: vektor (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í provoz 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 tiles 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 s relativním provozem 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 s počasím. Nejnovější infračervené satelitní snímky ukazují mraky podle jejich teploty. Projděte si informace o pokrytí služby Azure Maps Weather. Další informace o vrácených satelitních datech najdete v tématu Koncepty počasí.

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. Projděte si informace o pokrytí služby Azure Maps Weather. Další informace o radarových datech najdete v tématu Koncepty počasí.

Podporuje úrovně přiblížení 0 až 15. Formát: rastr (png).