Azure Maps Render Service (preview:1.0)

2025/04/07 • 2 updated methods

Render_GetMapTile (updated)
Description :  > [!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 the [latest version](/rest/api/maps/render) of the Render API by 9/17/26. 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](/azure/location-based-services/zoom-levels-and-tile-grid)) **Note**: Weather tiles are not available using the Get Map Tile v1.0 API. We recommend using the latest version of the [Get Map Tile](/rest/api/maps/render/get-map-tile) API.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Render_GetMapTile",
  "Description": {
    "new": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> 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 the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\n\nFetches 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](/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are not available using the Get Map Tile v1.0 API. We recommend using the latest version of the [Get Map Tile](/rest/api/maps/render/get-map-tile) API.",
    "old": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> 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 the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\n\nFetches 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](/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2)."
  }
}

⚼ Request

GET:  /map/tile/{format}
{
x-ms-client-id:
{
Description: 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](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Possible values are png & pbf. ,
Required: True ,
}
string ,
layer:
{
Description: Map layer requested. Possible values are basic, hybrid, labels and terra. ,
Required: True ,
}
string ,
style:
{
Description: Map style to be returned. Possible values are main, dark, and shaded_relief. ,
Required: True ,
}
string ,
zoom:
{
Description: Zoom level for the desired tile. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
x:
{
Description: X coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: Y coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
tileSize:
{
Description: The size of the returned map tile in pixels. ,
Required: False ,
}
string ,
language:
{
Description: 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](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
view:
{
Description: 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](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: The content-type for the response. ,
}
string ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Render_GetMapImageryTile (updated)
Description :  > [!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 the [latest version](/rest/api/maps/render) of the Render API by 9/17/26. The current available style value is 'satellite' which provides satellite imagery alone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Render_GetMapImageryTile",
  "Description": {
    "new": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> 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 the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\n The current available style value is 'satellite' which provides satellite imagery alone.\n",
    "old": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> 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 the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\n The current available style value is 'satellite' which provides satellite imagery alone.\n\n\n**Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2)."
  }
}

⚼ Request

GET:  /map/imagery/{format}
{
x-ms-client-id:
{
Description: 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](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Possible value: png. ,
Required: True ,
}
string ,
style:
{
Description: Map style to be returned. __Possible values:__ satellite. ,
Required: True ,
}
string ,
zoom:
{
Description: Zoom level for the desired tile. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
x:
{
Description: X coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: Y coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: The content-type for the response. ,
}
string ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}