Azure Maps Alias Service (preview:2.0)

2025/08/14 • 5 deleted methods

Alias_Create (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This API allows the caller to create an alias. You can also assign the alias during the create request. An alias can reference an ID generated by a creator service, but cannot reference another alias ID. ### Submit Create Request To create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter. ### Create Alias Response The Create API returns a HTTP `201 Created` response with the alias resource in the body. A sample response from creating an alias: ```json { "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" } ```
Reference :  Link ¶

⚼ Request

POST:  /aliases
{
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
creatorDataItemId:
{
Description: The unique id that references a creator data item to be aliased. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
access-control-expose-headers:
{
Description: The list of response headers that can be read by the client. ,
}
string ,
}
,
$schema:
{
Description: The response model for the Alias Create API for the case when the alias was successfully created. ,
}
{
createdTimestamp:
{
Description: The created timestamp for the alias. ,
Required: False ,
}
string ,
aliasId:
{
Description: The id for the alias. ,
Required: False ,
}
string ,
creatorDataItemId:
{
Description: The id for the creator data item that this alias references (could be null if the alias has not been assigned). ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: The timestamp of the last time the alias was assigned. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Alias_List (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This API allows the caller to fetch a list of all previously successfully created aliases. ### Submit List Request To list all your aliases, you will issue a `GET` request with no additional parameters. ### List Data Response The List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource: > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ > aliasId - The id for the alias. > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned). > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ A sample response returning 2 alias resources: ```json { "aliases": [ { "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" }, { "createdTimestamp": "2020-02-18T19:53:33.123Z", "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6", "creatorDataItemId": null, "lastUpdatedTimestamp": "2020-02-18T19:53:33.123Z" } ] } ```
Reference :  Link ¶

⚼ Request

GET:  /aliases
{
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
aliases:
{
Description: A list of all the previously created aliases. ,
Required: False ,
}
[
{
createdTimestamp:
{
Description: The created timestamp for the alias. ,
Required: False ,
}
string ,
aliasId:
{
Description: The id for the alias. ,
Required: False ,
}
string ,
creatorDataItemId:
{
Description: The id for the creator data item that this alias references (could be null if the alias has not been assigned). ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: The timestamp of the last time the alias was assigned. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: If present, the location of the next page of data. ,
Required: False ,
}
string ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Alias_Assign (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This API allows the caller to assign an alias to reference 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 ```json { "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" } ```
Reference :  Link ¶

⚼ Request

PUT:  /aliases/{aliasId}
{
aliasId:
{
Description: The unique id that references an existing alias. ,
Required: True ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
creatorDataItemId:
{
Description: The unique id that references a creator data item to be aliased. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Alias_Delete (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This API allows the caller to delete a previously created alias. You can also use this API to delete old/unused aliases to create space for new content.This API does not delete the references resource, only the alias referencing the resource. ### Submit Delete Request To delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete. ### Delete Alias Response The Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.
Reference :  Link ¶

⚼ Request

DELETE:  /aliases/{aliasId}
{
aliasId:
{
Description: The unique id that references an existing alias. ,
Required: True ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Alias_GetDetails (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This API allows the caller to fetch the details of a previously created alias. ### Submit Get Details Request To get the details of your alias, you will issue a `GET` request with the `aliasId` in the path. ### Get Details Response The Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource: > createdTimestamp - The timestamp that the alias was created. > aliasId - The id for the alias. > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned). > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Here's a sample response: ```json { "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" } ```
Reference :  Link ¶

⚼ Request

GET:  /aliases/{aliasId}
{
aliasId:
{
Description: The unique id that references an existing alias. ,
Required: True ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}