Map Configuration - Create
Use to create a map configuration.
For more information on what a map configuration is, see the Creator for indoor maps concepts article.
Submit Create Request
The Map Configuration Create
API is an HTTP POST
request used to create a new map configuration.
POST https://{geography}.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview
POST https://{geography}.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview&alias={alias}&description={description}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
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. |
alias
|
query |
string |
The alias of the map configuration. Maximum length 1024 characters. Alias cannot start with |
|
description
|
query |
string |
User provided description of the map configuration. Maximum length 1024 characters. |
Request Header
Media Types: "application/json", "application/zip"
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. |
Request Body
Media Types: "application/json", "application/zip"
Name | Required | Type | Description |
---|---|---|---|
version | True |
number |
The version of the map configuration, currently only version 1.0 is supported. |
configurations |
'Configurations' array will allow customer to configure different map representations for their tileset. Each configuration configured here will be reflected as one map style in style picker in client SDK. The name should be unique in the configurations array. |
||
defaultConfiguration |
string |
The default configuration for the map configuration. The value should be one of the 'name' field in ConfigurationObject under 'configurations' array. If not provided, first entry in the 'configurations' list will be used. |
|
description |
string |
The description the caller provided when creating the map configuration. Maximum length 1024 characters. |
Responses
Name | Type | Description |
---|---|---|
202 Accepted |
Request Accepted: The request has been accepted for processing. Please use the URL in the Operation-Location Header to obtain status. Headers Operation-Location: string |
|
Other Status Codes |
An unexpected error occurred. |
Security
AADToken
These are the Azure Active Directory OAuth2 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.
- Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.
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
Create a map configuration by providing a configuration file
Sample request
POST https://us.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview&alias=sample-alias&description=This is my first map configuration.
{
"version": 1,
"description": "This is Microsoft default indoor map configuration",
"defaultConfiguration": "microsoft_light",
"configurations": [
{
"name": "indoor_light",
"displayName": "Indoor light",
"description": "A base style for Azure Maps.",
"theme": "light",
"baseMap": "microsoft_light",
"layers": [
{
"tilesetId": "{tilesetId}",
"styleId": "microsoft-maps:indoor_2022-01-01"
}
]
},
{
"name": "indoor_dark",
"displayName": "Indoor dark",
"description": "A base style for Azure Maps.",
"theme": "dark",
"baseMap": "microsoft_dark",
"layers": [
{
"tilesetId": "{tilesetId}",
"styleId": "microsoft-maps:indoor_dark_2022-01-01"
}
]
}
]
}
Sample response
Operation-Location: https://us.atlas.microsoft.com/styles/mapConfigurations/operations/{operationId}?api-version=2022-01-01-preview
Access-Control-Expose-Headers: Operation-Location
Definitions
Name | Description |
---|---|
Base |
The base map is a background layer for private indoor map. This property is optional, no base map will show if not provided. Maximum length 100 characters. |
Configuration |
Define the format to configure a style picker and the associated map in client SDK. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Map |
A map configuration object which describes the map configuration json format. |
theme |
The theme for client SDK widgets(style picker, zoom, level picker). |
Tileset |
TilesetId and StyleId tuple |
BaseMap
The base map is a background layer for private indoor map. This property is optional, no base map will show if not provided. Maximum length 100 characters.
Name | Type | Description |
---|---|---|
microsoft_dark |
string |
The base dark road map style. |
microsoft_grayscale_dark |
string |
The grayscale dark map style. |
microsoft_grayscale_light |
string |
The grayscale light map style. |
microsoft_high_contrast_dark |
string |
The high contrast dark map style. |
microsoft_high_contrast_light |
string |
The high contrast light map style. |
microsoft_light |
string |
The base road map style. |
microsoft_satellite |
string |
The satellite imagery map style. |
microsoft_satellite_road |
string |
The satellite and road map style. |
microsoft_shaded_relief |
string |
The shaded relief map style. |
ConfigurationObject
Define the format to configure a style picker and the associated map in client SDK.
Name | Type | Description |
---|---|---|
baseMap |
The base map is a background layer for private indoor map. This property is optional, no base map will show if not provided. Maximum length 100 characters. |
|
description |
string |
The description for the style. Maximum length 500 characters. |
displayName |
string |
The display name for the style picker in client SDK. Maximum length 255 characters. |
layers |
To configure the style for tileset. You can have one style for the whole tileset. And you can have different styles for different layers in one tileset, for example, one style for |
|
name |
string |
The name for the style. Maximum length 255 characters. |
theme |
The theme for client SDK widgets(style picker, zoom, level picker). |
|
thumbnail |
string |
The thumbnail image file for the style picker in client SDK. Maximum length 255 characters. The size limit is 400KB and pixel limit is 512*512. |
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 |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
MapConfiguration
A map configuration object which describes the map configuration json format.
Name | Type | Description |
---|---|---|
configurations |
'Configurations' array will allow customer to configure different map representations for their tileset. Each configuration configured here will be reflected as one map style in style picker in client SDK. The name should be unique in the configurations array. |
|
defaultConfiguration |
string |
The default configuration for the map configuration. The value should be one of the 'name' field in ConfigurationObject under 'configurations' array. If not provided, first entry in the 'configurations' list will be used. |
description |
string |
The description the caller provided when creating the map configuration. Maximum length 1024 characters. |
version |
number |
The version of the map configuration, currently only version 1.0 is supported. |
theme
The theme for client SDK widgets(style picker, zoom, level picker).
Name | Type | Description |
---|---|---|
dark |
string |
The dark theme for client SDK widgets(style picker, zoom, level picker). |
light |
string |
The light theme for client SDK widgets(style picker, zoom, level picker). |
TilesetStyleTuple
TilesetId and StyleId tuple
Name | Type | Description |
---|---|---|
styleId |
string |
The unique id of an azure map style. Two predefined styleId aliases are |
tilesetId |
string |
The unique id of a tileset. |