Feature State - Create Stateset

參考

服務:: Maps Creator

API 版本:: 2.0

用來建立新的狀態集。

注意

Azure 地圖服務 Creator 功能狀態服務淘汰

Azure 地圖服務 Creator Feature State 服務現在已被取代，將於 3/31/25 淘汰。若要避免服務中斷，請 3/31/25 停止使用功能狀態服務。如需 Creator 中即時功能樣式的詳細資訊，請參閱使用即時地圖功能樣式增強室內地圖。

Create Stateset API 是用來建立新狀態集的 HTTP POST 要求，定義要求主體中其屬性的值和對應樣式。如需詳細資訊，請參閱功能狀態集 Create。

功能狀態服務可讓使用者更新功能的狀態，並查詢它們以用於其他服務。不屬於數據集的功能動態屬性稱為此處 的狀態 。

狀態集上的這項功能狀態服務樞紐。與圖格集一樣，狀態集會封裝數據集功能狀態的儲存機制。

建立狀態集之後，使用者就可以使用該 statesetId 狀態來張貼功能狀態更新，並擷取目前的功能狀態。功能在指定時間點只能有一個狀態。

功能狀態是由索引鍵名稱、值和時間戳所定義。當功能狀態更新張貼至 Azure 地圖服務時，只有當提供狀態的時間戳晚於預存時間戳時，狀態值才會更新。

Azure 地圖服務 MapControl 提供使用這些功能狀態來設定特徵樣式的方式。如需詳細資訊，請參閱轉譯服務取得地圖狀態圖格。

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 參數

名稱	位於	必要	類型	Description
geography	path	True	string	此參數會指定 Azure 地圖服務 Creator 資源所在的位置。有效值為us和 eu。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
datasetId	query	True	string	datasetId 必須已從成功的數據集 Create API 呼叫取得。
description	query		string	狀態集的描述。允許的最大長度為 1000。

要求標頭

名稱	必要	類型	Description
x-ms-client-id		string	指定哪一個帳戶用於搭配 Microsoft Entra ID 安全性模型使用。它代表 Azure 地圖服務帳戶的唯一標識符，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

要求本文

名稱	類型	Description
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	狀態集樣式規則的陣列。樣式規則可以是數值或字串或布爾類型樣式規則。請參閱這裡的 NumberRule、StringRule 和 BooleanRule 定義。

回應

名稱	類型	Description
200 OK	StatesetCreatedResult	已建立狀態集。
Other Status Codes	ErrorResponse	發生意外錯誤。

安全性

AADToken

這些是 Microsoft Entra OAuth 2.0 流程。與 Azure 角色型存取控制配對時，可用來控制對 REST API 的存取 Azure 地圖服務。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權，以 Azure 地圖服務 REST API。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義提供一個解決方案，可透過能夠針對特定 API 和範圍進行存取控制的物件，將應用程式模型化 () 。

備註

此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務資源。這可以從地圖服務管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Microsoft Entra ID 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。

如需 Microsoft 身分識別平台的詳細資訊，請參閱 Microsoft 身分識別平台概觀。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

這是在 Azure 入口網站或使用PowerShell、CLI、Azure SDK 或 REST API Create Azure 地圖服務帳戶時所佈建的共用金鑰。

使用此金鑰時，任何應用程式都可以存取所有 REST API。換句話說，此金鑰可作為發行帳戶中的主要金鑰。

對於公開的應用程式，我們建議使用機密用戶端應用程式方法來存取 Azure 地圖服務 REST API，以便安全地儲存您的密鑰。

類型: apiKey
位於: query

SAS Token

這是透過 Azure 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 地圖服務資源上的列出 SAS 作業建立共用存取簽章令牌。

使用此令牌時，任何應用程式都有權使用 Azure 角色型訪問控制進行存取，並精細控制到期、速率和區域 (特定令牌的使用) 。換句話說，SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式控制存取。

對於公開的應用程式，我們建議在地圖帳戶資源上設定允許的來源特定清單，以限制轉譯濫用，並定期更新 SAS 令牌。

類型: apiKey
位於: header

範例

Create a new stateset with a datasetId

範例要求

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

範例回覆

狀態碼:: 200

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

定義

名稱	Description
BooleanRule	布爾值規則。根據索引鍵的邏輯值選取色彩。
BooleanStyleRule	布爾型別樣式規則物件。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
NumberRule	數值規則。色彩是從其落在第一個範圍中選取。
NumberStyleRule	數值類型樣式規則物件。
Range	此樣式規則的數值範圍。如果值位於範圍內，則所有條件都必須保留 true。
StatesetCreatedResult	成功狀態集 Create API 的回應模型。
StringStyleRule	字串類型樣式規則物件。
StyleRules	樣式模型。

BooleanRule

布爾值規則。根據索引鍵的邏輯值選取色彩。

名稱	類型	Description
false	string	值為 false 時的色彩。色彩是各種允許格式、HTML 樣式十六進位值、RGB (“#ff0”、“#ffff00”、“rgb (255、255、0) ”) 、RGBA (“rgba (255、 255、0、1) ”) 、HSL (“hsl (100、50%) ”) “) 和 HSLA (”hsla (100、50%50%、50%50%、1) “) 。也允許預先定義的 HTML 色彩名稱，例如黃色和藍色。
true	string	值為 true 時的色彩。色彩是各種允許格式、HTML 樣式十六進位值、RGB (“#ff0”、“#ffff00”、“rgb (255、255、0) ”) 、RGBA (“rgba (255、 255、0、1) ”) 、HSL (“hsl (100、50%) ”) “) 和 HSLA (”hsla (100、50%50%、50%50%、1) “) 。也允許預先定義的 HTML 色彩名稱，例如黃色和藍色。

BooleanStyleRule

布爾型別樣式規則物件。

名稱	類型	Description
keyName	string	狀態集樣式索引鍵名稱。索引鍵名稱是隨機字串，但在樣式數位應該是唯一的。
rules	BooleanRule[]	布爾樣式規則。
type	string: boolean	狀態集樣式的類型。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

NumberRule

數值規則。色彩是從其落在第一個範圍中選取。

名稱	類型	Description
color	string	值在範圍內時的色彩。色彩是各種允許格式、HTML 樣式十六進位值、RGB (“#ff0”、“#ffff00”、“rgb (255、255、0) ”) 、RGBA (“rgba (255、 255、0、1) ”) 、HSL (“hsl (100、50%) ”) “) 和 HSLA (”hsla (100、50%50%、50%50%、1) “) 。也允許預先定義的 HTML 色彩名稱，例如黃色和藍色。
range	Range	此樣式規則的數值範圍。如果值位於範圍內，則所有條件都必須保留 true。

NumberStyleRule

數值類型樣式規則物件。

名稱	類型	Description
keyName	string	狀態集樣式索引鍵名稱。索引鍵名稱是隨機字串，但在樣式數位應該是唯一的。
rules	NumberRule[]	數值樣式規則。
type	string: number	狀態集樣式的類型。

Range

此樣式規則的數值範圍。如果值位於範圍內，則所有條件都必須保留 true。

名稱	類型	Description
exclusiveMaximum	string	x < exclusiveMaximum 的所有數位 x。
exclusiveMinimum	string	x > exclusiveMinimum 的所有數位。
maximum	string	x ≤最大值的所有數位 x。
minimum	string	x ≥下限的所有數位 x。

StatesetCreatedResult

成功狀態集 Create API 的回應模型。

名稱	類型	Description
statesetId	string	建立之新狀態集的標識碼。

StringStyleRule

字串類型樣式規則物件。

名稱	類型	Description
keyName	string	狀態集樣式索引鍵名稱。索引鍵名稱是隨機字串，但在樣式數位應該是唯一的。
rules	object[]	字串樣式規則。
type	string: string	狀態集樣式的類型。

StyleRules

樣式模型。

名稱	類型	Description
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	狀態集樣式規則的陣列。樣式規則可以是數值或字串或布爾類型樣式規則。請參閱這裡的 NumberRule、StringRule 和 BooleanRule 定義。

共用方式為