Render - Get Map Tile

Applies to: S0 and S1 pricing tiers.

Fetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see Zoom Levels and Tile Grid)

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

URI Parameters

Name In Required Type Description
format
path True

Desired format of the response. Possible values are png & pbf.

subscription-key
query
  • string

One of the Azure Maps keys provided from an Azure Map Account. Refer to the subscription-key security definition.

api-version
query True
  • string

Version number of Azure Maps API. Current version is 1.0

layer
query True

Map layer requested. Possible values are basic, hybrid, labels and terra.

style
query True

Map style to be returned. Possible values are main & shaded_relief.

zoom
query True
  • integer

Zoom level for the desired tile. For raster tiles, value must be in the range: 0-18 (inclusive). Terra raster tiles, values must be in the range 0-6 (inclusive). For vector tiles, value must be in the range: 0-20 (inclusive).

Please see Zoom Levels and Tile Grid for details.

x
query True
  • integer

X coordinate of the tile on zoom grid. Value must be in the range [0, 2zoom -1].

Please see Zoom Levels and Tile Grid for details.

y
query True
  • integer

Y coordinate of the tile on zoom grid. Value must be in the range [0, 2zoom -1].

Please see Zoom Levels and Tile Grid for details.

tileSize
query

The size of the returned map tile in pixels.

language
query
  • string

Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.

Please refer to Supported Languages for details.

Request Header

Name Required Type Description
x-ms-client-id
  • string

Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following articles for guidance.

Responses

Name Type Description
200 OK
  • string

OK

Media Types: "image/png", "image/pbf", "application/json"

400 Bad Request

Bad request: one or more parameters were incorrectly specified or are mutually exclusive.

Media Types: "image/png", "image/pbf", "application/json"

401 Unauthorized

Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the WWW-Authenticate header for error code and description of the provided AAD bearer token.

Media Types: "image/png", "image/pbf", "application/json"

Headers

  • WWW-Authenticate: string
403 Forbidden

Permission, capacity, or authentication issues.

Media Types: "image/png", "image/pbf", "application/json"

404 Not Found

Not Found: the requested resource could not be found, but it may be available again in the future.

Media Types: "image/png", "image/pbf", "application/json"

500 Internal Server Error

An error occurred while processing the request. Please try again later.

Media Types: "image/png", "image/pbf", "application/json"

Security

azure_auth

These are the Azure Active Directory OAuth2 Flows. When paired with Azure Role Based Access control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Note

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.
  • The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations.
  • The Azure role based access control is configured from the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.
  • Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.
  • Currently Azure Active Directory v1.0 tokens are supported.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

subscription-key

This is a shared key which is provisioned when creating an Azure Maps resource through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.

Type: apiKey
In: query

Examples

GetMapTile

Sample Request

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

Sample Response

"binary string image"
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definitions

Error

This object is returned when an error occurs in the Maps API

ErrorResponse

This response object is returned when an error occurs in the Maps API

MapTileLayer

Map layer requested. Possible values are basic, hybrid, labels and terra.

MapTileSize

The size of the returned map tile in pixels.

MapTileStyle

Map style to be returned. Possible values are main & shaded_relief.

TileFormat

Desired format of the response. Possible values are png & pbf.

Error

This object is returned when an error occurs in the Maps API

Name Type Description
code
  • string

The HTTP status code.

message
  • string

If available, a human readable description of the error.

ErrorResponse

This response object is returned when an error occurs in the Maps API

Name Type Description
error

This object is returned when an error occurs in the Maps API

MapTileLayer

Map layer requested. Possible values are basic, hybrid, labels and terra.

Name Type Description
basic
  • string

Returns a tile containing all map features including polygons, borders, roads and labels.

hybrid
  • string

Returns a tile containing borders, roads, and labels, and can be overlaid on other tiles (such as satellite imagery) to produce hybrid tiles.

labels
  • string

Returns a tile of just the map's label information.

terra
  • string

Map canvas complete with shaded relief tiles. Zoom levels 0-6 (inclusive) are supported. Png is the only supported TileFormat and only available MapTileSize is 512.

MapTileSize

The size of the returned map tile in pixels.

Name Type Description
256
  • string
512
  • string

MapTileStyle

Map style to be returned. Possible values are main & shaded_relief.

Name Type Description
main
  • string

Azure Maps main style

shaded_relief
  • string

Azure Maps main style completed with shaded relief. Supported by Layer terra.

TileFormat

Desired format of the response. Possible values are png & pbf.

Name Type Description
pbf
  • string

Vector graphic in the pbf format. Supports zoom levels 0 through 20.

png
  • string

An image in the png format. Supports zoom levels 0 through 18.