Render - Get Map Tile

Note

Azure Maps Render v1 service retirement

The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use Render v2 API by 9/17/26.

Applies to: see 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)

Note: Weather tiles are only available via Get Map Tile V2 API. We recommend to start to use the new Get Map Tile V2 API.

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}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}&tileSize={tileSize}&language={language}&view={view}

URI Parameters

Name In Required Type Description
format
path True

TileFormat

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

api-version
query True

string

Version number of Azure Maps API.

layer
query True

MapTileLayer

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

style
query True

MapTileStyle

Map style to be returned. Possible values are main, dark, and shaded_relief.

x
query True

integer

int32

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

int32

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.

zoom
query True

integer

int32

Zoom level for the desired tile.

Please see Zoom Levels and Tile Grid for details.

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.

tileSize
query

MapTileSize

The size of the returned map tile in pixels.

view
query

LocalizedMapView

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.

Please refer to Supported Views for details and to see the available Views.

Request Header

Name Required Type Description
x-ms-client-id

string

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

Responses

Name Type Description
200 OK

object

This image is returned from a successful Get Map Tile call

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

Headers

Content-Type: string

Other Status Codes

ErrorResponse

An unexpected error occurred.

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

Security

AADToken

These are the Microsoft Entra OAuth 2.0 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.

Notes

  • 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 Microsoft Entra ID 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.

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

This is a shared key that is provisioned when you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.

With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.

For publicly exposed applications, our recommendation is to use the confidential client applications approach to access Azure Maps REST APIs so your key can be securely stored.

Type: apiKey
In: query

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.

For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

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

Content-Type: image/png
"{file}"

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

LocalizedMapView

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.

Please refer to Supported Views for details and to see the available Views.

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, dark, and shaded_relief.

TileFormat

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

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

LocalizedMapView

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.

Please refer to Supported Views for details and to see the available Views.

Name Type Description
AE

string

United Arab Emirates (Arabic View)

AR

string

Argentina (Argentinian View)

Auto

string

Return the map data based on the IP address of the request.

BH

string

Bahrain (Arabic View)

IN

string

India (Indian View)

IQ

string

Iraq (Arabic View)

JO

string

Jordan (Arabic View)

KW

string

Kuwait (Arabic View)

LB

string

Lebanon (Arabic View)

MA

string

Morocco (Moroccan View)

OM

string

Oman (Arabic View)

PK

string

Pakistan (Pakistani View)

PS

string

Palestinian Authority (Arabic View)

QA

string

Qatar (Arabic View)

SA

string

Saudi Arabia (Arabic View)

SY

string

Syria (Arabic View)

Unified

string

Unified View (Others)

YE

string

Yemen (Arabic View)

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

Return a 256 by 256 pixel tile.

512

string

Return a 512 by 512 pixel tile.

MapTileStyle

Map style to be returned. Possible values are main, dark, and shaded_relief.

Name Type Description
dark

string

Dark grey version of the Azure Maps main style. PNG is the only supported TileFormat.

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 22.

png

string

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