Dela via

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 gör det möjligt för användare att begära kartrutor i antingen vektor- eller rasterformat, vanligtvis för integrering i en kartkontroll eller SDK. Stödda tile-typer inkluderar Azure Maps-vägtiles och realtids-Weather Radar-tiles. Som standard använder Azure Maps Web SDK vektorplattor för att rendera sin webbkartkontroll.

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. 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 tilesets som tillhandahålls av Azure Maps listas 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)

Zoomnivå 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 anges till 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 inom 5 minuters intervall. 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 över sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som programmet 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 view-parametern korrekt för den platsen. Du kan också 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 gällande lagar, inklusive de som rör kartläggning, i det land/region där kartor, bilder och annan data samt tredjepartsinnehåll som du är auktoriserad att få tillgång till 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 med Microsoft Entra ID-säkerhetsmodellen. Detta unika ID för Azure Maps-kontot kan erhållas från Azure Maps Management Plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps.

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

Ett oväntat fel uppstod.

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Säkerhet

AADToken

Dessa är Microsoft Entra OAuth 2.0 flöden. När den kombineras med Azure rollbaserad åtkomst kontroll kan den användas för att kontrollera åtkomst till Azure Maps REST-API:er. Azure:s rollbaserade åtkomstkontroller används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller delresurser. Varje användare, grupp eller tjänstehuvudperson kan beviljas åtkomst via en inbyggd roll eller en anpassad roll bestående 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.

Notes

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

Authorization URL är specifik för den Azure publika molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer. * Den Azure rollbaserade åtkomstkontrollen konfigureras från Azure hanteringsplanet via Azure portal, PowerShell, CLI, Azure SDKs eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad installation av en applikation för flera användningsområden.

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

Detta är en delad nyckel som provisioneras när man skapar en Azure Maps resurs via Azure hanteringsplanet via Azure portal, PowerShell, CLI, Azure SDKs 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 applikationer rekommenderar vi att använda server-till-server-åtkomst till Azure Maps REST-API:er där denna nyckel kan lagras säkert.

Typ: apiKey
I: header

SAS Token

Detta är en delad åtkomstsignaturtoken som skapas från List SAS-operationen på Azure Maps resursen via Azure hanteringsplanet via Azure portal, PowerShell, CLI, Azure SDKs eller REST-API:er.

Med denna token är varje applikation auktoriserad att använda Azure:s rollbaserade åtkomstkontroller och finkornig kontroll till utgångsdatum, hastighet och region(er) för användning för den aktuella 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 Tile Request

Exempelbegäran

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

Detaljerna om felet.
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 över sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som programmet 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 view-parametern korrekt för den platsen. Du kan också 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 gällande lagar, inklusive de som rör kartläggning, i det land/region där kartor, bilder och annan data samt tredjepartsinnehåll som du är auktoriserad att få tillgång till 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 att använda när du gör begäranden. De färdiga tilesets som tillhandahålls av Azure Maps listas nedan. Till exempel microsoft.base.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetail

Objekt

Detaljerna om felet.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

LocalizedMapView

Uppräkning

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 över sådana regioner, och med parametern Visa kan ditt program uppfylla den vy som krävs av det land/den region som programmet 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 view-parametern korrekt för den platsen. Du kan också 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 gällande lagar, inklusive de som rör kartläggning, i det land/region där kartor, bilder och annan data samt tredjepartsinnehåll som du är auktoriserad att få tillgång till 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.

Värde Description
AE

Förenade Arabemiraten (arabisk vy)
AR

Argentina (argentinsk vy)
BH

Bahrain (arabisk vy)
IN

Indien (indisk vy)
IQ

Irak (arabisk vy)
JO

Jordanien (arabisk vy)
KW

Kuwait (arabisk vy)
LB

Libanon (arabisk vy)
MA

Marocko (marockansk vy)
OM

Oman (arabisk vy)
PK

Pakistan (pakistansk vy)
PS

Palestinska myndigheten (arabisk vy)
QA

Qatar (arabisk vy)
SA

Saudiarabien (arabisk vy)
SY

Syrien (arabisk vy)
US

United States of America
YE

Jemen (arabisk vy)
Auto

Returnera kartdata baserat på IP-adressen för begäran.
Unified

Enhetlig vy (andra)

MapTileSize

Uppräkning

Storleken på den returnerade kartpanelen i bildpunkter.

Värde Description
256

Returnera en panel på 256 x 256 bildpunkter.
512

Returnera en panel på 512 med 512 bildpunkter.

TilesetID

Uppräkning

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 tilesets som tillhandahålls av Azure Maps listas 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. För mer information om Azure Maps Weather Service-bevakningen, se Azure Maps vädertjänstens bevakning. För mer information om radardata, se Vädertjänster i Azure Maps.

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. För mer information, se Azure Maps vädertjänstens täckning. För mer information om de satellitdata som returnerats, se Vädertjänster i Azure Maps.

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