Feature State - Create Stateset

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

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}

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

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

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 プラットフォームの概要」を参照してください。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

subscription-key

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

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

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

型: apiKey
/: query

SAS Token

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

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

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

型: apiKey
/: header

例

Create a new stateset with a datasetId

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"
        }
      ]
    }
  ]
}

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

定義

BooleanRule

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

BooleanStyleRule

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

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

NumberRule

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

NumberStyleRule

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

Range

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

StatesetCreatedResult

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

StringStyleRule

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

StyleRules

スタイル モデル。