Feature State - Create Stateset

Use to create a new stateset.

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 Create Stateset API is an HTTP POST request used to create a new stateset, defining the values and corresponding styles for its properties in the body of the request. For more information, see Create a feature stateset.

The Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as states here.

This Feature State service pivot on the stateset. Like tileset, stateset encapsulates the storage mechanism for feature states for a dataset.

Once the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time.

Feature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp.

Azure Maps MapControl provides a way to use these feature states to style the features. For more information, see the Render services Get Map State Tile.

POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}
POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}&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.

datasetId
query True

string

The datasetId must have been obtained from a successful Dataset Create API call.

description
query

string

Description for the stateset. Max length allowed is 1000.

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.

Request Body

Name Type Description
styles StyleRule[]:

An array of stateset style rules. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRule, StringRule and BooleanRule definitions here.

Responses

Name Type Description
200 OK

StatesetCreatedResult

Stateset created.

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 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 new stateset with a datasetId

Sample request

POST https://us.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId=5d34fbe8-87b7-f7c0-3144-c50e003a3c75&description=Stateset for Azure Maps POC.

{
  "styles": [
    {
      "keyName": "s1",
      "type": "boolean",
      "rules": [
        {
          "true": "#FF0000",
          "false": "#00FF00"
        }
      ]
    },
    {
      "keyName": "s2",
      "type": "number",
      "rules": [
        {
          "range": {
            "exclusiveMaximum": "50"
          },
          "color": "#343deb"
        },
        {
          "range": {
            "minimum": "50",
            "exclusiveMaximum": "70"
          },
          "color": "#34ebb1"
        },
        {
          "range": {
            "minimum": "70",
            "exclusiveMaximum": "90"
          },
          "color": "#eba834"
        },
        {
          "range": {
            "minimum": "90"
          },
          "color": "#eb3434"
        }
      ]
    },
    {
      "keyName": "s3",
      "type": "string",
      "rules": [
        {
          "stateValue1": "#FF0000",
          "stateValue2": "#FF00AA",
          "stateValueN": "#00FF00"
        }
      ]
    }
  ]
}

Sample response

{
  "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f"
}

Definitions

Name Description
BooleanRule

The boolean rule. The color is selected based on the logic value of the key.

BooleanStyleRule

The boolean type style rule object.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

NumberRule

The numeric rule. The color is selected from the first range it falls into.

NumberStyleRule

The numeric type style rule object.

Range

The numeric value range for this style rule. If the value is in the range, all the conditions must hold true.

StatesetCreatedResult

The response model for the successful Stateset Create API.

StringStyleRule

The string type style rule object.

StyleRules

The styles model.

BooleanRule

The boolean rule. The color is selected based on the logic value of the key.

Name Type Description
false

string

The color when value is false. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), and HSLA("hsla(100, 50%, 50%, 1)"). Predefined HTML colors names, like yellow and blue, are also permitted.

true

string

The color when value is true. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), and HSLA("hsla(100, 50%, 50%, 1)"). Predefined HTML colors names, like yellow and blue, are also permitted.

BooleanStyleRule

The boolean type style rule object.

Name Type Description
keyName

string

Stateset style key name. Key names are random strings but they should be unique inside style array.

rules

BooleanRule[]

Boolean style rules.

type string:

boolean

The type of stateset style.

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.

NumberRule

The numeric rule. The color is selected from the first range it falls into.

Name Type Description
color

string

The color when value is within the range. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), and HSLA("hsla(100, 50%, 50%, 1)"). Predefined HTML colors names, like yellow and blue, are also permitted.

range

Range

The numeric value range for this style rule. If the value is in the range, all the conditions must hold true.

NumberStyleRule

The numeric type style rule object.

Name Type Description
keyName

string

Stateset style key name. Key names are random strings but they should be unique inside style array.

rules

NumberRule[]

Numeric style rules.

type string:

number

The type of stateset style.

Range

The numeric value range for this style rule. If the value is in the range, all the conditions must hold true.

Name Type Description
exclusiveMaximum

string

All the number x that x < exclusiveMaximum.

exclusiveMinimum

string

All the number x that x > exclusiveMinimum.

maximum

string

All the number x that x ≤ maximum.

minimum

string

All the number x that x ≥ minimum.

StatesetCreatedResult

The response model for the successful Stateset Create API.

Name Type Description
statesetId

string

The ID for the new stateset created.

StringStyleRule

The string type style rule object.

Name Type Description
keyName

string

Stateset style key name. Key names are random strings but they should be unique inside style array.

rules

object[]

String style rules.

type string:

string

The type of stateset style.

StyleRules

The styles model.

Name Type Description
styles StyleRule[]:

An array of stateset style rules. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRule, StringRule and BooleanRule definitions here.