Render - Get Map Tile

Tjänst:

Maps

API-version:

2024-04-01

Använd för att begära kartpaneler i vektor- eller rasterformat.

API:et Get Map Tiles i en HTTP GET-begäran som gör det möjligt för användare att begära kartpaneler i vektor- eller rasterformat som vanligtvis ska integreras i en kartkontroll eller SDK. Några exempelpaneler som kan begäras är Azure Maps-vägpaneler, väderradarpaneler i realtid eller kartpaneler som skapats med Azure Maps Creator. Som standard använder Azure Maps vektorpaneler för webbkartkontrollen (Web SDK) och Android SDK.

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

Med valfria parametrar:

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

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 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.
x	query	True	integer int32	X-koordinat för panelen i zoomrutnätet. Värdet måste ligga i intervallet [0, 2zoom -1]. Mer information finns i Zoomnivåer och Panelrutnät .
y	query	True	integer int32	Y-koordinat för panelen i zoomrutnätet. Värdet måste ligga i intervallet [0, 2zoom -1]. Mer information finns i Zoomnivåer och Panelrutnät .
zoom	query	True	integer int32	Zoomningsnivå för önskad panel. Mer information finns i Zoomnivåer och Panelrutnät .
language	query		string	Språk där sökresultat ska returneras. Bör vara en av IETF-språktaggar som stöds, skiftlägesokänsliga. När data på angivet språk inte är tillgängliga för ett visst fält används standardspråket. Mer information finns i Språk som stöds .
tileSize	query		MapTileSize	Storleken på den returnerade kartpanelen i bildpunkter.
timeStamp	query		string date-time	Önskat datum och tid för den begärda panelen. Den här parametern måste anges i standardformatet date-time (t.ex. 2019-11-14T16:03:00-08:00), enligt definitionen i ISO 8601. Den här parametern stöds bara när parametern tilesetId är inställd på något av värdena nedan. microsoft.weather.infrared.main: Vi tillhandahåller paneler upp till 3 timmar tidigare. Paneler är tillgängliga inom 10 minuters intervall. Vi avrundar timeStamp-värdet till närmaste tidsram på 10 minuter. microsoft.weather.radar.main: Vi tillhandahåller paneler upp till 1,5 timmar tidigare och upp till 2 timmar i framtiden. Paneler är tillgängliga i 5-minutersintervall. Vi avrundar timeStamp-värdet till närmaste tidsram på 5 minuter.
view	query		LocalizedMapView	Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa platsen för dina användare och ange sedan parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. View-parametern i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN. Mer information finns i Vyer som stöds och för att se tillgängliga vyer.

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. Det 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	object	Panelen som returnerades från ett lyckat API-anrop. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Sidhuvuden Content-Type: string
Other Status Codes	ErrorResponse	Det uppstod ett oväntat fel. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

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 ha å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-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet 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.

• 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 för Rest-API:er för Azure Maps 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 List 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 säkrare 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 Tile Request

Exempelbegäran

HTTP

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22

Exempelsvar

Statuskod:

200

Content-Type: application/vnd.mapbox-vector-tile

"binary image string"

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
LocalizedMapView	Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa användarnas plats och sedan ange parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. View-parametern i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN. Mer information finns i Vyer som stöds och för att se tillgängliga vyer.
MapTileSize	Storleken på den returnerade kartpanelen i bildpunkter.
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.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

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.

LocalizedMapView

Med parametern Visa (kallas även parametern "användarregion" kan du visa rätt kartor för ett visst land/en viss region för geopolitiskt omtvistade regioner. Olika länder/regioner har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som ditt program kommer att betjäna. Som standard är view-parametern inställd på "Unified" även om du inte har definierat den i begäran. Det är ditt ansvar att fastställa användarnas plats och sedan ange parametern Visa korrekt för den platsen. Alternativt kan du välja att ange "View=Auto", som returnerar kartdata baserat på IP-adressen för begäran. View-parametern i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. Exempel: view=IN.

Mer information finns i Vyer som stöds och för att se tillgängliga vyer.

Name	Typ	Description
AE	string	Förenade Arabemiraten (arabisk vy)
AR	string	Argentina (argentinsk vy)
Auto	string	Returnera kartdata baserat på IP-adressen för begäran.
BH	string	Bahrain (arabisk vy)
IN	string	Indien (indisk vy)
IQ	string	Irak (arabisk vy)
JO	string	Jordanien (arabisk vy)
KW	string	Kuwait (arabisk vy)
LB	string	Libanon (arabisk vy)
MA	string	Marocko (marockansk vy)
OM	string	Oman (arabisk vy)
PK	string	Pakistan (pakistansk vy)
PS	string	Palestinska myndigheten (arabisk vy)
QA	string	Qatar (arabisk vy)
SA	string	Saudiarabien (arabisk vy)
SY	string	Syrien (arabisk vy)
Unified	string	Enhetlig vy (andra)
YE	string	Jemen (arabisk vy)

MapTileSize

Storleken på den returnerade kartpanelen i bildpunkter.

Name	Typ	Description
256	string	Returnera en panel på 256 x 256 bildpunkter.
512	string	Returnera en panel på 512 med 512 bildpunkter.

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.

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 zoomningsnivåer 0 till och med 22. Format: vektor (pbf).
microsoft.base.darkgrey	string	Alla lager med vår mörkgrå stil. Stöder zoomningsnivå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 zoomningsnivå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 zoomningsnivå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 zoomningsnivå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 zoomningsnivåer 0 till och med 22. Format: vektor (pbf).
microsoft.base.labels.darkgrey	string	Märka data i vår mörkgrå stil. Stöder zoomningsnivåer 0 till och med 22. Format: raster (png).
microsoft.base.labels.road	string	Märk data i vårt huvudformat. Stöder zoomningsnivåer 0 till och med 22. Format: raster (png).
microsoft.base.road	string	Alla lager med vårt huvudformat. Stöder zoomningsnivåer 0 till och med 22. Format: raster (png).
microsoft.imagery	string	En kombination av satellit- och flygfoton. 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 terralager. 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 temperatur. Mer information finns i Täckning för Azure Maps-vädertjänster. 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äder radar plattor. Senaste väderradarbilder inklusive områden med regn, snö, is och blandade förhållanden. Mer information om täckningen för Vädertjänsten i Azure Maps finns i Avsnittet om vädertjänster i Azure Maps. Mer information om radardata finns i Vädertjänster i Azure Maps. Stöder zoomningsnivåer 0 till och med 15. Format: raster (png).