Alias - Assign

Reference

Service:: Maps Creator

API Version:: 2.0

Use to assign an alias as a reference to a resource.

Note

Azure Maps Creator retirement

The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see End of Life Announcement of Azure Maps Creator.

The Assign API is an HTTP PUT request used to assign an alias as a reference to a resource.

Submit Assign Request

To assign your alias to a resource, you will use a PUT request with the aliasId in the path and the creatorDataItemId passed as a query parameter.

Assign Alias Response

The Assign API returns a HTTP 200 OK response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is

{
  "createdTimestamp": "2020-02-13T21:19:11.123Z",
  "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
  "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
  "lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
}

PUT https://{geography}.atlas.microsoft.com/aliases/{aliasId}?api-version=2.0&creatorDataItemId={creatorDataItemId}

URI Parameters

Name	In	Required	Type	Description
aliasId	path	True	string	The unique id that references an existing alias.
geography	path	True	string	This parameter specifies where the Azure Maps Creator resource is located. Valid values are us and eu.
api-version	query	True	string	Version number of Azure Maps API.
creatorDataItemId	query	True	string	The unique id that references a creator data item to be aliased.

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	Alias	Alias was assigned successfully.
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 Azure Active directory 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

Assign an alias to a resource

Sample request

HTTP

PUT https://us.atlas.microsoft.com/aliases/[aliasId]?api-version=2.0&creatorDataItemId=[creatorDataItemId]

Sample response

Status code:: 200

{
  "createdTimestamp": "2021-05-01T01:02:03.456Z",
  "aliasId": "25084fb7-307a-4720-8f91-7952a0b91012",
  "creatorDataItemId": "633a009a-dfa2-4d51-a419-420122e11c94",
  "lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z"
}

Definitions

Name	Description
Alias	Detailed information for the alias.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

Alias

Detailed information for the alias.

Name	Type	Description
aliasId	string	The id for the alias.
createdTimestamp	string	The created timestamp for the alias.
creatorDataItemId	string	The id for the creator data item that this alias references (could be null if the alias has not been assigned).
lastUpdatedTimestamp	string	The timestamp of the last time the alias was assigned.

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.

Share via