Render - Get Map Imagery Tile
Returns a map image tile with size 256x256, given the x and y coordinates and zoom level, which ranges from 1 to 19.
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.
The current available style value is 'satellite' which provides satellite imagery alone.
Note: We recommend to start to use the new Get Map Tile V2 API.
GET https://atlas.microsoft.com/map/imagery/png?api-version=1.0&style=satellite&zoom={zoom}&x={x}&y={y}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
format
|
path | True |
Desired format of the response. Possible value: png. |
|
api-version
|
query | True |
string |
Version number of Azure Maps API. |
style
|
query | True |
Map style to be returned. Possible values: satellite. |
|
x
|
query | True |
integer int32 |
X coordinate of the tile on zoom grid. Value must be in the range [0, 2 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, 2 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. |
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 Imagery Tile call Media Types: "application/json", "image/jpeg", "image/png" Headers Content-Type: string |
Other Status Codes |
An unexpected error occurred. Media Types: "application/json", "image/jpeg", "image/png" |
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.
- For more information on Microsoft identity platform, see Microsoft identity platform overview.
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 Imagery Tile Request
Sample request
GET https://atlas.microsoft.com/map/imagery/png?api-version=1.0&style=satellite&zoom=6&x=10&y=22
Sample response
Content-Type: image/png
"{file}"
Definitions
Name | Description |
---|---|
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Map |
Map style to be returned. Possible values: satellite. |
Raster |
Desired format of the response. Possible value: png. |
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 |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
MapImageryStyle
Map style to be returned. Possible values: satellite.
Name | Type | Description |
---|---|---|
satellite |
string |
Satellite imagery |
RasterTileFormat
Desired format of the response. Possible value: png.
Name | Type | Description |
---|---|---|
png |
string |
An image in the png format. Supports zoom levels 0 through 18. |