Sign in

v5

latestSwagger 2.02026-07-13914107.7 KB

Use to get metadata for a tileset.

The Get Map Tileset API allows users to request metadata for a tileset.

get/map/tileset

Query parameters

api-versionstring required

The API version to use for this operation.

tilesetId'microsoft.base' | 'microsoft.base.labels' | 'microsoft.base.hybrid' | 'microsoft.terra.main' | 'microsoft.base.road' | 'microsoft.base.darkgrey' | 'microsoft.base.labels.road' | 'microsoft.base.labels.darkgrey' | 'microsoft.base.hybrid.road' | 'microsoft.base.hybrid.darkgrey' | 'microsoft.imagery' | 'microsoft.weather.radar.main' | 'microsoft.weather.infrared.main' | 'microsoft.traffic.absolute' | 'microsoft.traffic.absolute.main' | 'microsoft.traffic.relative' | 'microsoft.traffic.relative.main' | 'microsoft.traffic.relative.dark' | 'microsoft.traffic.delay' | 'microsoft.traffic.delay.main' | 'microsoft.traffic.reduced.main' | 'microsoft.traffic.incident' required

A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a tilesetId to use when making requests. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.

Headers

x-ms-client-idstring

Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see Manage authentication in Azure Maps.

Response

The request has succeeded.

tilejsonstring

Describes the version of the TileJSON spec that is implemented by this JSON object.

namestring

A name describing the tileset. The name can contain any legal character. Implementations SHOULD NOT interpret the name as HTML.

descriptionstring

Text description of the tileset. The description can contain any legal character. Implementations SHOULD NOT interpret the description as HTML.

versionstring

A semver.org style version number for the tiles contained within the tileset. When changes across tiles are introduced, the minor version MUST change.

attributionstring

Copyright attribution to be displayed on the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking.

templatestring

A mustache template to be used to format data from grids for interaction.

legendstring

A legend to be displayed with the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking.

schemestring

Default: "xyz". Either "xyz" or "tms". Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed.

tilesstring[]

An array of tile endpoints. If multiple endpoints are specified, clients may use any combination of endpoints. All endpoints MUST return the same content for the same URL. The array MUST contain at least one endpoint.

gridsstring[]

An array of interactivity endpoints.

datastring[]

An array of data files in GeoJSON format.

minzoominteger

The minimum zoom level.

maxzoominteger

The maximum zoom level.

boundsnumber[]

The maximum extent of available map tiles. Bounds MUST define an area covered by all zoom levels. The bounds are represented in WGS:84 latitude and longitude values, in the order left, bottom, right, top. Values may be integers or floating point numbers.

centernumber[]

The default location of the tileset in the form [longitude, latitude, zoom]. The zoom level MUST be between minzoom and maxzoom. Implementations can use this value to set the default location.