Render - Get Map Tile

  • Referens
Service:
Maps
API Version:
1.0

Gäller för: se prisnivåer.

Hämtar kartpaneler i vektor- eller rasterformat som vanligtvis ska integreras i en ny kartkontroll eller SDK. Som standard använder Azure vektorkartpaneler för webbkartkontrollen (se Zoomnivåer och Panelrutnät)

Obs! Väderpaneler är bara tillgängliga via API:et Hämta kartpanel V2. Vi rekommenderar att du börjar använda det nya V2-API:et hämta kartpanel.

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}
With optional parameters: 
GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}&tileSize={tileSize}&language={language}&view={view}

URI-parametrar

Name In Required Type Description
format
 path True

Önskat format för svaret. Möjliga värden är png & pbf.
api-version
 query True
  • string

Versionsnummer för Azure Maps API.
layer
 query True

Kartlager begärs. Möjliga värden är grundläggande, hybrid, etiketter och terra.
style
 query True

Kartformat som ska returneras. Möjliga värden är huvudsakliga, mörka och shaded_relief.
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 Rutnät för paneler .
y
 query True
  • integer
int32

Y-koordinaten för panelen i zoomrutnätet. Värdet måste ligga i intervallet [0, 2zoom -1].

Mer information finns i Zoomnivåer och Rutnät för paneler .
zoom
 query True
  • integer
int32

Zoomnivå för önskad panel.

Mer information finns i Zoomnivåer och Rutnät för paneler .
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å det angivna språket 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

Storleken på den returnerade kartpanelen i bildpunkter.
view
 query

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 har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla vyn som krävs av det land 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 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. Parametern Visa i Azure Maps måste användas i enlighet med gällande lagar, inklusive de som gäller mappning, i det land 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 Required Type Description
x-ms-client-id
  • string

Anger vilket konto som är avsett för användning tillsammans med Azure AD säkerhetsmodell. 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 Azure AD säkerhet i Azure Maps finns i följande artiklar.

Svar

Name Type Description
200 OK
  • object

Den här bilden returneras från ett lyckat Get Map Tile-anrop

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

Headers

  • Content-Type: string
Other Status Codes

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 Azure Active Directory OAuth2-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure 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 resurskonto 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 för att 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 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 som 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 Azure Active Directory-konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, 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.

  • För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för arbete, skola och gäster, men har inte stöd för personliga konton.

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

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure Portal eller använder PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, 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.

Type: apiKey
In: header

Exempel

Successful Tile Request

Sample Request

GET https://atlas.microsoft.com/map/tile/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22

Sample Response

Status code:
200 
Content-Type: image/png
Response Body
"{file}"

Definitioner

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 har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla vyn som krävs av det land 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. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, i det land 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.
MapTileLayer

Kartlager begärs. Möjliga värden är grundläggande, hybrid, etiketter och terra.
MapTileSize

Storleken på den returnerade kartpanelen i bildpunkter.
MapTileStyle

Kartformat som ska returneras. Möjliga värden är huvudsakliga, mörka och shaded_relief.
TileFormat

Önskat format för svaret. Möjliga värden är png & pbf.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Type Description
info
  • object

Ytterligare information.
type
  • string

Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name Type Description
additionalInfo

Ytterligare information om felet.
code
  • string

Felkoden.
details

Felinformationen.
message
  • string

Felmeddelandet.
target
  • string

Felmålet.

ErrorResponse

Felsvar

Name Type Description
error

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 har olika vyer för sådana regioner, och med parametern Visa kan ditt program uppfylla vyn som krävs av det land 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. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, i det land 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 Type 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)

MapTileLayer

Kartlager begärs. Möjliga värden är grundläggande, hybrid, etiketter och terra.

Name Type Description
basic
  • string

Returnerar en panel som innehåller alla kartfunktioner, inklusive polygoner, kantlinjer, vägar och etiketter.
hybrid
  • string

Returnerar en panel som innehåller kantlinjer, vägar och etiketter och kan läggas över på andra paneler (till exempel satellitbilder) för att skapa hybridpaneler.
labels
  • string

Returnerar en panel med bara kartans etikettinformation.
terra
  • string

Mappa arbetsytan komplett med skuggade reliefpaneler. Zoomnivåer 0–6 (inklusive) stöds. Png är det enda panelformat som stöds och endast tillgänglig MapTileSize är 512.

MapTileSize

Storleken på den returnerade kartpanelen i bildpunkter.

Name Type Description
256
  • string

Returnera en panel på 256 x 256 bildpunkter.
512
  • string

Returnera en panel på 512 med 512 bildpunkter.

MapTileStyle

Kartformat som ska returneras. Möjliga värden är huvudsakliga, mörka och shaded_relief.

Name Type Description
dark
  • string

Mörkgrå version av Azure Maps huvudstil. PNG är det enda panelformat som stöds.
main
  • string

Azure Maps huvudformat
shaded_relief
  • string

Azure Maps huvudstil kompletteras med skuggad lättnad. Stöds av Layer terra.

TileFormat

Önskat format för svaret. Möjliga värden är png & pbf.

Name Type Description
pbf
  • string

Vektorgrafik i pbf-format. Stöder zoomnivåer 0 till och med 22.
png
  • string

En bild i png-format. Stöder zoomnivåer 0 till och med 18.