Render - Get Map Attribution

Use to get map copyright attribution information.

The Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.

GET https://atlas.microsoft.com/map/attribution?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&bounds={bounds}

URI Parameters

Name In Required Type Description
api-version
query True

string

Version number of Azure Maps API. Current version is 2024-04-01.

bounds
query True

number[]

The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: [SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude].

tilesetId
query True

TilesetID

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 tilesetId for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.

zoom
query True

integer

int32

Zoom level for the desired map attribution.

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

MapAttribution

OK

Other Status Codes

ErrorResponse

An unexpected error occurred.

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 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: header

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 Attribution Request

Sample request

GET https://atlas.microsoft.com/map/attribution?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&bounds=-122.414162,47.57949,-122.247157,47.668372

Sample response

{
  "copyrights": [
    "<a data-azure-maps-attribution-tileset=\"microsoft.base\">&copy;2022 TomTom</a>"
  ]
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

MapAttribution

Copyright attribution for the requested section of a tileset.

TilesetID

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 tilesetId for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.

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.

MapAttribution

Copyright attribution for the requested section of a tileset.

Name Type Description
copyrights

string[]

A list of copyright strings.

TilesetID

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 tilesetId for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.

Name Type Description
microsoft.base

string

A base map is a standard map that displays roads, natural and artificial features along with the labels for those features in a vector tile.

Supports zoom levels 0 through 22. Format: vector (pbf).

microsoft.base.darkgrey

string

All layers with our dark grey style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.base.hybrid

string

Displays road, boundary and label data in a vector tile.

Supports zoom levels 0 through 22. Format: vector (pbf).

microsoft.base.hybrid.darkgrey

string

Road, boundary and label data in our dark grey style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.base.hybrid.road

string

Road, boundary and label data in our main style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.base.labels

string

Displays labels for roads, natural and artificial features in a vector tile.

Supports zoom levels 0 through 22. Format: vector (pbf).

microsoft.base.labels.darkgrey

string

Label data in our dark grey style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.base.labels.road

string

Label data in our main style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.base.road

string

All layers with our main style.

Supports zoom levels 0 through 22. Format: raster (png).

microsoft.imagery

string

A combination of satellite or aerial imagery. Only available in S1 and G2 pricing SKU.

Supports zoom levels 1 through 19. Format: raster (png).

microsoft.terra.main

string

Shaded relief and terra layers.

Supports zoom levels 0 through 6. Format: raster (png).

microsoft.traffic.absolute

string

absolute traffic tiles in vector

microsoft.traffic.absolute.main

string

absolute traffic tiles in raster in our main style.

microsoft.traffic.delay

string

traffic tiles in vector

microsoft.traffic.delay.main

string

traffic tiles in raster in our main style

microsoft.traffic.incident

string

incident tiles in vector

microsoft.traffic.reduced.main

string

reduced traffic tiles in raster in our main style

microsoft.traffic.relative

string

relative traffic tiles in vector

microsoft.traffic.relative.dark

string

relative traffic tiles in raster in our dark style.

microsoft.traffic.relative.main

string

relative traffic tiles in raster in our main style.

microsoft.weather.infrared.main

string

Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. For more information, see Azure Maps weather services coverage. For more information about the satellite data returned, see Weather services in Azure Maps.

Supports zoom levels 0 through 15. Format: raster (png).

microsoft.weather.radar.main

string

Weather radar tiles. Latest weather radar images including areas of rain, snow, ice and mixed conditions. For more information on the Azure Maps Weather service coverage, see Azure Maps weather services coverage. For more information on Radar data, see Weather services in Azure Maps.

Supports zoom levels 0 through 15. Format: raster (png).