Render - Get Map Tileset

Referens

Tjänst:: Maps

API-version:: 2024-04-01

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

MED API:et Get Map Tileset kan användare 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. Den aktuella versionen ä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 som du kan använda när du gör begäranden. TilesetId för paneluppsättningar som skapats med Azure Maps Creator genereras via API:et Tileset Create. De färdiga paneluppsättningarna som tillhandahålls av Azure Maps visas nedan. Till exempel microsoft.base.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-id		string	Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID-säkerhetsmodellen. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Microsoft Entra ID-säkerhet i Azure Maps finns i följande artiklar .

Svar

Name	Typ	Description
200 OK	MapTileset	OK
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. 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 Rest-API:er för Azure Maps.

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.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.

Authorization URL är specifikt 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-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Webb-SDK för Azure Maps möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

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 har utfärdats för.

För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst till 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 åtgärden Lista SAS 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 av 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 återgivningsmissbruk och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Successful Tileset Request

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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
  ]
}

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 som ska användas när begäranden görs. TilesetId för paneluppsättningar som skapats med Azure Maps Creator genereras via API:et Tileset Create. 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	Den ytterligare informationen.
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 ser du 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 värden för latitud och longitud i WGS:84, i den ordning som är vänster, nederkant, höger, överst. Värden kan vara heltal eller flyttalsnummer.
center	number[]	Standardplatsen för paneluppsättningen i formatet [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 ser du till att det här fältet inte kan missbrukas som en vektor för XSS- eller beaconspårning.
maxzoom	integer	Maximal zoomningsnivå.
minzoom	integer	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 panelkoordinaternas y-riktning. Profilen global-mercator (även kallat 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	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	Ett semver.org formatversionsnummer 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 som ska användas när begäranden görs. TilesetId för paneluppsättningar som skapats med Azure Maps Creator genereras via API:et Tileset Create. De färdiga paneluppsättningar som tillhandahålls av Azure Maps visas nedan. Till exempel microsoft.base.

Name	Typ	Description
microsoft.base	string	En baskarta är en standardkarta som visar vägar, naturliga och artificiella funktioner tillsammans med etiketterna för dessa funktioner i en vektorpanel. Stöder zoomnivåer 0 till och med 22. Format: vektor (pbf).
microsoft.base.darkgrey	string	Alla lager med vår mörkgrå stil. Stöder zoomnivåer 0 till och med 22. Format: raster (png).
microsoft.base.hybrid	string	Visar väg-, gräns- och etikettdata i en vektorpanel. Stöder zoomnivåer 0 till och med 22. Format: vektor (pbf).
microsoft.base.hybrid.darkgrey	string	Väg-, gräns- och etikettdata i vår mörkgrå stil. Stöder zoomnivåer 0 till och med 22. Format: raster (png).
microsoft.base.hybrid.road	string	Väg-, gräns- och etikettdata i vårt huvudformat. Stöder zoomnivåer 0 till och med 22. Format: raster (png).
microsoft.base.labels	string	Visar etiketter för vägar, naturliga och artificiella funktioner i en vektorpanel. Stöder zoomnivåer 0 till och med 22. Format: vektor (pbf).
microsoft.base.labels.darkgrey	string	Etikettera data i vår mörkgrå stil. Stöder zoomnivåer 0 till och med 22. Format: raster (png).
microsoft.base.labels.road	string	Märk data i vårt huvudformat. Stöder zoomnivåer 0 till och med 22. Format: raster (png).
microsoft.base.road	string	Alla lager med vårt huvudformat. Stöder zoomnivåer 0 till och med 22. Format: raster (png).
microsoft.imagery	string	En kombination av satellit- och flygbilder. Endast tillgängligt i S1-prissättnings-SKU. Stöder zoomningsnivåer 1 till 19. Format: raster (jpeg).
microsoft.terra.main	string	Skuggade relief- och terraskikt. Stöder zoomningsnivåer 0 till och med 6. Format: raster (png).
microsoft.traffic.absolute	string	absoluta trafikpaneler i vektor
microsoft.traffic.absolute.main	string	absoluta trafikpaneler i raster i vårt huvudformat.
microsoft.traffic.delay	string	trafikpaneler i vektor
microsoft.traffic.delay.main	string	trafikpaneler i raster i vårt huvudformat
microsoft.traffic.incident	string	incidentpaneler i vektor
microsoft.traffic.reduced.main	string	minskade trafikpaneler i raster i vårt huvudformat
microsoft.traffic.relative	string	relativa trafikpaneler i vektor
microsoft.traffic.relative.dark	string	relativa trafikpaneler i raster i vår mörka stil.
microsoft.traffic.relative.main	string	relativa trafikpaneler i raster i vårt huvudformat.
microsoft.weather.infrared.main	string	Väder infraröda plattor. De senaste infraröda satellitbilderna visar moln efter deras temperatur. Mer information finns i Azure Maps vädertjänster täckning. Mer information om de satellitdata som returneras finns i Vädertjänster i Azure Maps. Stöder zoomningsnivåer 0 till och med 15. Format: raster (png).
microsoft.weather.radar.main	string	Väderradarpaneler. Senaste väder radar bilder inklusive områden av regn, snö, is och blandade förhållanden. Mer information om Azure Maps vädertjänsttäckning finns i Azure Maps vädertjänsters täckning. Mer information om radardata finns i Vädertjänster i Azure Maps. Stöder zoomningsnivåer 0 till och med 15. Format: raster (png).

Dela via