Dela via


Render - Get Map Tileset

Använd för att hämta metadata för en paneluppsättning.

API:et Hämta kartpaneler gör det möjligt för användare att begära metadata för en paneluppsättning.

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

URI-parametrar

Name I Obligatorisk Typ Description
api-version
query True

string

Versionsnummer för Azure Maps API. Aktuell version är 2024-04-01.

tilesetId
query True

TilesetID

En paneluppsättning är en samling raster- eller vektordata uppdelade i ett enhetligt rutnät med fyrkantiga paneler på förinställda zoomnivåer. Varje paneluppsättning har ett tilesetId att använda när du gör begäranden. De färdiga paneluppsättningar som tillhandahålls av Azure Maps visas nedan. Till exempel microsoft.base.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Anger det konto som är avsett att användas med Microsoft Entra ID-säkerhetsmodellen. Det här unika ID:t för Azure Maps-kontot kan hämtas från Azure Maps konto-API:et för hanteringsplanet. Mer information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i Hantera autentisering i Azure Maps.

Svar

Name Typ Description
200 OK

MapTileset

OK

Other Status Codes

ErrorResponse

Ett oväntat fel uppstod.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Noteringar

  • Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.

Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer. * Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

subscription-key

Det här är en delad nyckel som etableras när du skapar en Azure Maps-resurs via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de utfärdas för.

För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst för Azure Maps REST-API:er där den här nyckeln kan lagras på ett säkert sätt.

Typ: apiKey
I: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll till förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på Map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Successful Tileset Request

Exempelbegäran

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

Exempelsvar

{
  "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
  ]
}

Definitioner

Name Description
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

MapTileset

Metadata för en paneluppsättning i TileJSON-format.

TilesetID

En paneluppsättning är en samling raster- eller vektordata uppdelade i ett enhetligt rutnät med fyrkantiga paneler på förinställda zoomnivåer. Varje paneluppsättning har ett tilesetId att använda när du gör begäranden. De färdiga paneluppsättningar som tillhandahålls av Azure Maps visas nedan. Till exempel microsoft.base.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

MapTileset

Metadata för en paneluppsättning i TileJSON-format.

Name Typ Description
attribution

string

Upphovsrättsattribution som ska visas på kartan. Implementeringar KAN besluta att behandla detta som HTML- eller literaltext. Av säkerhetsskäl bör du se till att det här fältet inte kan missbrukas som en vektor för XSS- eller beaconspårning.

bounds

number[]

Den maximala omfattningen av tillgängliga kartpaneler. Gränser MÅSTE definiera ett område som omfattas av alla zoomnivåer. Gränserna representeras i WGS:84 latitud- och longitudvärden, i ordningen vänster, nederkant, höger, överkant. Värden kan vara heltal eller flyttalsnummer.

center

number[]

Standardplatsen för paneluppsättningen i formuläret [longitud, latitud, zoom]. Zoomnivån MÅSTE vara mellan minzoom och maxzoom. Implementeringar kan använda det här värdet för att ange standardplatsen.

data

string[]

En matris med datafiler i GeoJSON-format.

description

string

Textbeskrivning av paneluppsättningen. Beskrivningen kan innehålla alla juridiska tecken. Implementeringar BÖR INTE tolka beskrivningen som HTML.

grids

string[]

En matris med interaktivitetsslutpunkter.

legend

string

En förklaring som ska visas med kartan. Implementeringar KAN besluta att behandla detta som HTML- eller literaltext. Av säkerhetsskäl bör du se till att det här fältet inte kan missbrukas som en vektor för XSS- eller beaconspårning.

maxzoom

integer

minimum: 0
maximum: 30

Den maximala zoomnivån.

minzoom

integer

minimum: 0
maximum: 30

Minsta zoomnivå.

name

string

Ett namn som beskriver paneluppsättningen. Namnet kan innehålla alla juridiska tecken. Implementeringar BÖR INTE tolka namnet som HTML.

scheme

string

Standard: "xyz". Antingen "xyz" eller "tms". Påverkar y-riktningen för panelkoordinaterna. Profilen global-mercator (även kallad sfärisk mercator) antas.

template

string

En mustaschmall som ska användas för att formatera data från rutnät för interaktion.

tilejson

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

Beskriver versionen av TileJSON-specifikationen som implementeras av det här JSON-objektet.

tiles

string[]

En matris med panelslutpunkter. Om flera slutpunkter anges kan klienter använda valfri kombination av slutpunkter. Alla slutpunkter MÅSTE returnera samma innehåll för samma URL. Matrisen MÅSTE innehålla minst en slutpunkt.

version

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

Ett semver.org versionsnummer för panelerna i paneluppsättningen. När ändringar mellan paneler introduceras måste delversionen ändras.

TilesetID

En paneluppsättning är en samling raster- eller vektordata uppdelade i ett enhetligt rutnät med fyrkantiga paneler på förinställda zoomnivåer. Varje paneluppsättning har ett tilesetId att använda när du gör begäranden. De färdiga paneluppsättningar som tillhandahålls av Azure Maps visas nedan. Till exempel microsoft.base.

Värde Description
microsoft.base

En baskarta är en standardkarta som visar vägar, naturliga och artificiella funktioner tillsammans med etiketterna för dessa funktioner i en vektorpanel.

Har stöd för zoomningsnivåer 0 till 22. Format: vektor (pbf).

microsoft.base.labels

Visar etiketter för vägar, naturliga och artificiella funktioner i en vektorpanel.

Har stöd för zoomningsnivåer 0 till 22. Format: vektor (pbf).

microsoft.base.hybrid

Visar väg-, gräns- och etikettdata i en vektorpanel.

Har stöd för zoomningsnivåer 0 till 22. Format: vektor (pbf).

microsoft.terra.main

Skuggade relief- och terraskikt.

Stöder zoomningsnivåer 0 till 6. Format: raster (png).

microsoft.base.road

Alla lager med vårt huvudformat.

Har stöd för zoomningsnivåer 0 till 22. Format: raster (png).

microsoft.base.darkgrey

Alla lager med vår mörkgrå stil.

Har stöd för zoomningsnivåer 0 till 22. Format: raster (png).

microsoft.base.labels.road

Etikettera data i vårt huvudformat.

Har stöd för zoomningsnivåer 0 till 22. Format: raster (png).

microsoft.base.labels.darkgrey

Etikettera data i vårt mörkgrå format.

Har stöd för zoomningsnivåer 0 till 22. Format: raster (png).

microsoft.base.hybrid.road

Väg-, gräns- och etikettdata i vårt huvudformat.

Har stöd för zoomningsnivåer 0 till 22. Format: raster (png).

microsoft.base.hybrid.darkgrey

Väg-, gräns- och etikettdata i vår mörkgrå stil.

Har stöd för zoomningsnivåer 0 till 22. Format: raster (png).

microsoft.imagery

En kombination av satellit- eller flygbilder. Endast tillgängligt i S1- och G2-prissättnings-SKU.

Stöder zoomningsnivåer 1 till 19. Format: raster (png).

microsoft.weather.radar.main

Väder radar plattor. Senaste väder radar bilder inklusive områden av regn, snö, is och blandade förhållanden. Mer information om täckningen för Azure Maps Weather-tjänsten finns i Azure Maps täckning för vädertjänster. Mer information om radardata finns i Vädertjänster i Azure Kartor.

Stöder zoomnivåer 0 till och med 15. Format: raster (png).

microsoft.weather.infrared.main

Väder infraröda plattor. De senaste bilderna från infraröda satelliter visar moln efter temperatur. Mer information finns i Azure Maps täckning av vädertjänster. Mer information om de satellitdata som returneras finns i Vädertjänster i Azure Kartor.

Stöder zoomnivåer 0 till och med 15. Format: raster (png).

microsoft.traffic.absolute

absoluta trafikpaneler i vektor

microsoft.traffic.absolute.main

absoluta trafikpaneler i raster i vårt huvudformat.

microsoft.traffic.relative

relativa trafikpaneler i vektor

microsoft.traffic.relative.main

relativa trafikpaneler i raster i vårt huvudformat.

microsoft.traffic.relative.dark

relativa trafikpaneler i raster i vår mörka stil.

microsoft.traffic.delay

trafikpaneler i vektor

microsoft.traffic.delay.main

trafikpaneler i raster i vårt huvudformat

microsoft.traffic.reduced.main

minskade trafikpaneler i raster i vårt huvudformat

microsoft.traffic.incident

incidentpaneler i vektor