Feature State - Create Stateset

リファレンス

Service:: Maps Creator

API Version:: 2.0

を使用して新しいステートセットを作成します。

注意

Azure Maps Creator Feature State サービスの廃止

Azure Maps Creator Feature State サービスは非推奨となり、3/31/25 に廃止されます。サービスの中断を回避するには、3/31/25 までに Feature State サービスの使用を中止してください。 Creator のリアルタイムフィーチャスタイル設定の詳細については、「リアルタイムマップフィーチャスタイルを使用して屋内マップを強化する」を参照してください。

Create Stateset API は、新しい状態セットを作成するために使用される HTTP POST 要求であり、要求の本文でプロパティの値と対応するスタイルを定義します。詳細については、「機能状態セットのCreate」を参照してください。

Feature State サービスを使用すると、ユーザーは機能の状態を更新し、他のサービスで使用するようにクエリを実行できます。データセットに属していないフィーチャの動的プロパティは、ここで状態と呼ばれます。

この機能状態サービスは、ステートセット上でピボットします。タイルセットと同様に、stateset はデータセットの特徴状態のストレージメカニズムをカプセル化します。

ステートセットが作成されると、ユーザーはその statesetId 状態を使用して機能状態の更新を投稿し、現在の機能状態を取得できます。機能の状態は、特定の時点で 1 つだけです。

機能の状態は、キー名、値、およびタイムスタンプによって定義されます。機能状態の更新がAzure Mapsにポストされると、指定された状態のタイムスタンプが格納されているタイムスタンプより後の場合にのみ、状態値が更新されます。

Azure Maps MapControl では、これらの機能状態を使用してフィーチャのスタイルを設定できます。詳細については、「Render services Get Map State Tile」を参照してください。

POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}

With optional parameters:

POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}&description={description}

URI パラメーター

名前	/	必須	型	説明
geography	path	True	string	このパラメーターは、Azure Maps Creator リソースの場所を指定します。有効な値は、us と eu です。
api-version	query	True	string	Azure Maps API のバージョン番号。
datasetId	query	True	string	datasetId は、正常な Dataset Create API 呼び出しから取得されている必要があります。
description	query		string	stateset の説明。使用できる最大長は 1000 です。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーンアカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、次の記事を参照してください。

要求本文

名前	型	説明
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	stateset スタイルルールの配列。スタイルルールには、数値または文字列、またはブール型のスタイルルールを指定できます。ここでは、NumberRule、StringRule、BooleanRule の各定義を参照してください。

応答

名前	型	説明
200 OK	StatesetCreatedResult	Stateset が作成されました。
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、任意のユーザー、グループ、またはサービスプリンシパルにアクセス権 Azure Mapsを付与できます。

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

メモ

このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。これは、 Maps 管理 API から取得できます。

Authorization URLは、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、固有の承認 URL とMicrosoft Entra ID構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対してアプリケーションを構成ベースで設定できます。

Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure portalでAzure Maps アカウントをCreateするとき、または PowerShell、CLI、Azure SDK、または REST API を使用するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。つまり、このキーは、発行されたアカウントのマスターキーとして使用できます。

公開されているアプリケーションの場合は、機密クライアントアプリケーションのアプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。

Type: apiKey
In: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して、Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

Type: apiKey
In: header

例

Create a new stateset with a datasetId

Sample Request

HTTP

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

Status code:: 200

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

定義

名前	説明
BooleanRule	ブール値の規則。キーのロジック値に基づいて色が選択されます。
BooleanStyleRule	ブール型のスタイルルールオブジェクト。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
NumberRule	数値ルール。色は、最初の範囲から選択されます。
NumberStyleRule	数値型のスタイルルールオブジェクト。
Range	このスタイルルールの数値範囲。値が範囲内にある場合は、すべての条件が true を保持する必要があります。
StatesetCreatedResult	成功した Stateset Create API の応答モデル。
StringStyleRule	文字列型のスタイルルールオブジェクト。
StyleRules	スタイルモデル。

BooleanRule

ブール値の規則。キーのロジック値に基づいて色が選択されます。

名前	型	説明
false	string	値が false の場合の色。 Color は、さまざまな許可された形式の JSON 文字列、HTML スタイルの 16 進値、RGB ("#ff0"、 "#ffff00"、"rgb(255, 255, 0)")、RGBA ("rgba(255, 255, 0, 1)"),HSL("hsl(100, 50%, 50%)")、HSLA("hsla(100, 50%, 50%, 1)")。黄色や青などの定義済みの HTML 色名も使用できます。
true	string	値が true の場合の色。 Color は、さまざまな許可された形式の JSON 文字列、HTML スタイルの 16 進値、RGB ("#ff0"、 "#ffff00"、"rgb(255, 255, 0)")、RGBA ("rgba(255, 255, 0, 1)"),HSL("hsl(100, 50%, 50%)")、HSLA("hsla(100, 50%, 50%, 1)")。黄色や青などの定義済みの HTML 色名も使用できます。

BooleanStyleRule

ブール型のスタイルルールオブジェクト。

名前	型	説明
keyName	string	Stateset スタイルのキー名。キー名はランダムな文字列ですが、スタイル配列内で一意である必要があります。
rules	BooleanRule[]	ブール型のスタイル規則。
type	string: boolean	ステートセットスタイルの種類。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

NumberRule

数値ルール。色は、最初の範囲から選択されます。

名前	型	説明
color	string	値が範囲内にある場合の色。 Color は、さまざまな許可された形式の JSON 文字列、HTML スタイルの 16 進値、RGB ("#ff0"、 "#ffff00"、"rgb(255, 255, 0)")、RGBA ("rgba(255, 255, 0, 1)"),HSL("hsl(100, 50%, 50%)")、HSLA("hsla(100, 50%, 50%, 1)")。黄色や青などの定義済みの HTML 色名も使用できます。
range	Range	このスタイルルールの数値範囲。値が範囲内にある場合は、すべての条件が true を保持する必要があります。

NumberStyleRule

数値型のスタイルルールオブジェクト。

名前	型	説明
keyName	string	Stateset スタイルのキー名。キー名はランダムな文字列ですが、スタイル配列内で一意である必要があります。
rules	NumberRule[]	数値スタイルの規則。
type	string: number	ステートセットスタイルの種類。

Range

このスタイルルールの数値範囲。値が範囲内にある場合は、すべての条件が true を保持する必要があります。

名前	型	説明
exclusiveMaximum	string	x exclusiveMaximum のすべての数値 x < 。
exclusiveMinimum	string	x exclusiveMinimum のすべての数値 x > 。
maximum	string	x が最大≤すべての数値 x。
minimum	string	x が最小≥すべての数値 x。

StatesetCreatedResult

成功した Stateset Create API の応答モデル。

名前	型	説明
statesetId	string	作成された新しいステートセットの ID。

StringStyleRule

文字列型のスタイルルールオブジェクト。

名前	型	説明
keyName	string	Stateset スタイルのキー名。キー名はランダムな文字列ですが、スタイル配列内で一意である必要があります。
rules	object[]	文字列スタイルの規則。
type	string: string	ステートセットスタイルの種類。

StyleRules

スタイルモデル。

名前	型	説明
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	stateset スタイルルールの配列。スタイルルールには、数値または文字列、またはブール型のスタイルルールを指定できます。ここでは、NumberRule、StringRule、BooleanRule の各定義を参照してください。