{
"opencollection": "1.0.0",
"info": {
"name": "Microsoft Azure AccessControlClient AccessConnector Styles API",
"version": "2020-08-01-preview"
},
"items": [
{
"info": {
"name": "Styles",
"type": "folder"
},
"items": [
{
"info": {
"name": "Microsoft Azure Use To Get A List Of All Map Configurations",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/styles/mapconfigurations",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Version number of Azure Maps API."
}
]
},
"docs": "
### Submit List Request
The Map Configuration `List` API is an HTTP `GET` request used to get a list of all map configurations.
"
},
{
"info": {
"name": "Microsoft Azure Use To Create A Map Configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/styles/mapconfigurations",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Version number of Azure Maps API."
},
{
"name": "alias",
"value": "",
"type": "query",
"description": "The alias of the map configuration. Maximum length 1024 characters. Alias cannot start with `microsoft-maps` which is a reserved prefix. Alias can be provided optionally during creating a map configuration, and can be used as same as mapConfigurationId after map configuration creation."
},
{
"name": "description",
"value": "",
"type": "query",
"description": "User provided description of the map configuration. Maximum length 1024 characters."
}
]
},
"docs": "
For more information on what a map configuration is, see the [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps#map-configuration) concepts article.
### Submit Create Request
The Map Configuration `Create` API is an HTTP `POST` request used to create a new map configuration."
},
{
"info": {
"name": "Microsoft Azure Use To Get A Map Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/styles/mapconfigurations/:mapConfigurationId",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Version number of Azure Maps API."
},
{
"name": "mapConfigurationId",
"value": "",
"type": "path",
"description": "The map configuration Id."
}
]
},
"docs": "
### Submit Get Request
The Map Configuration `Get` API is an HTTP `GET` request used to get a map configuration. The response contains a zip file with the map configuration JSON and any image files it references. You can always get the default map configuration using predefined alias `defaultIndoor_{tilesetId}` for a given tileset if you deleted the auto-generated map configuration. The two predefined styles used in default map configuration are `microsoft-maps:indoor_2022-01-01`"
},
{
"info": {
"name": "Microsoft Azure Use To Delete A Map Configuration",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/styles/mapconfigurations/:mapConfigurationId",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Version number of Azure Maps API."
},
{
"name": "mapConfigurationId",
"value": "",
"type": "path",
"description": "The map configuration Id."
}
]
},
"docs": "
The Map Configuration `Delete` API is an HTTP `DELETE` request used to delete a map configuration. For more information on what a map configuration is, see the [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps#map-configuration) concepts article.
### Submit Delete Request
An `HTTP DELETE` request with the `mapConfigurationId` in the path of the request is required to remove an existing map configuration from your Azure Maps account.
#### Delete requ"
},
{
"info": {
"name": "Microsoft Azure Use To Check The Status Of The Map Configuration Creation Process",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/styles/mapconfigurations/operations/:operationId",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Version number of Azure Maps API."
},
{
"name": "operationId",
"value": "",
"type": "path",
"description": "The ID to query the status for the map configuration create request."
}
]
},
"docs": "
The `Get Operation` API is an HTTP `GET` request used to check the status of the map configuration creation process.
### Submit Operations Request
To view the current progress of a map configuration operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.
### Operation Response
While in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` ht"
},
{
"info": {
"name": "Microsoft Azure Use To Get A List Of Styles",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/styles",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Version number of Azure Maps API."
}
]
},
"docs": "
The `List` API is an HTTP `GET` request that allows the caller to fetch a list of all styles in the current Azure Maps Creator account. The default indoor style `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01` will not show in the list response. But you can still use it as your own style by the predefined alias.
### Submit List Request"
},
{
"info": {
"name": "Microsoft Azure Use To Create An Azure Maps Style",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/styles",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Version number of Azure Maps API."
},
{
"name": "description",
"value": "",
"type": "query",
"description": "User provided description of the style. Maximum length 1024 characters."
},
{
"name": "alias",
"value": "",
"type": "query",
"description": "The alias of the style. Maximum length 1024 characters. Alias cannot start with `microsoft-maps` which is a reserved prefix. Alias can be provided optionally during creating a style, and can be used as same as styleId after style creation. "
}
]
},
"docs": "
## Submit Create Request
The `Style Create` API is an HTTP `POST` request used to create an Azure Maps style by passing in either a JSON or ZIP file containing the style information.
The Create Style API is a [long-running operation](https://aka.ms/am-creator-lrt-v2)."
},
{
"info": {
"name": "Microsoft Azure Use To Get Details Of A Style",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/styles/:styleId",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Version number of Azure Maps API."
},
{
"name": "styleId",
"value": "",
"type": "path",
"description": "The Style Id."
}
]
},
"docs": "
### Submit Get Request
The `Get` API is an HTTP `GET` request that allows the caller to fetch the details of an existing style by passing in the `styleId` or its [alias](). Get the two predefined default styles using the alias `microsoft-maps:indoor_2022-01-01` for indoor light and `microsoft-maps:indoor_dark_2022-01-01` for indoor dark."
},
{
"info": {
"name": "Microsoft Azure Use To Delete A Style",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/styles/:styleId",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Version number of Azure Maps API."
},
{
"name": "styleId",
"value": "",
"type": "path",
"description": "The Style Id."
}
]
},
"docs": "
### Submit Delete Request
The `Delete` API is an HTTP `DELETE` request that is used to delete the specified style, where the path will contain the `styleId` of the style to delete.
#### Delete request \"Successful\"
The Style Delete API returns a HTTP `204 No Content` response with an empty body, if the style was deleted successfully.
#### Delete request \"Failed\"
A HTTP `400 Bad Request` error response will be returned if the style with the pass"
},
{
"info": {
"name": "Microsoft Azure Use To Check The Status Of The Style Creation Process",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/styles/operations/:operationId",
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Version number of Azure Maps API."
},
{
"name": "operationId",
"value": "",
"type": "path",
"description": "The ID to query the status for the style create request."
}
]
},
"docs": "
The `Get Operation` API is an HTTP `GET` request used to check the status of the style creation process and retrieve the `styletId`.
### Submit Operations Request
To view the current progress of a style operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.
### Operation Response
While in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK"
}
]
}
],
"bundled": true
}