Feature State - Get Stateset

參考

服務:: Maps Creator

API 版本:: 2.0

使用擷取狀態集資訊。

注意

Azure 地圖服務 Creator Feature State 服務淘汰

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

Get Stateset API 是用來擷取指定狀態集資訊的 HTTP GET 要求，包括datasetId與狀態集相關聯的，以及其樣式。

GET https://{geography}.atlas.microsoft.com/featureStateSets/{statesetId}?api-version=2.0

URI 參數

名稱	位於	必要	類型	Description
geography	path	True	string	此參數會指定 Azure 地圖服務 Creator 資源所在的位置。有效值為us和 eu。
statesetId	path	True	string	已建立的狀態集標識碼。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。

要求標頭

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

回應

名稱	類型	Description
200 OK	Stateset	成功完成要求。
Other Status Codes	ErrorResponse	發生意外錯誤。

安全性

AADToken

這些是 Microsoft Entra OAuth 2.0 流程。與 Azure 角色型存取控制配對時，可用來控制對 Azure 地圖服務 REST API 的存取。 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

範例

Get stateset information with a statesetId

範例要求

HTTP

GET https://us.atlas.microsoft.com/featureStateSets/b24bdb73-1305-3212-1909-a428d937b64?api-version=2.0

範例回覆

狀態碼:: 200

{
  "description": "Stateset for Azure Maps POC.",
  "datasetIds": [
    "8d700cc7-fd2c-4e21-b402-ad3f5e524f36"
  ],
  "statesetStyle": {
    "styles": [
      {
        "keyName": "s1",
        "type": "boolean",
        "rules": [
          {
            "true": "#FFFF00",
            "false": "#FFFFFF"
          }
        ]
      },
      {
        "keyName": "s2",
        "type": "number",
        "rules": [
          {
            "range": {
              "minimum": null,
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": "50"
            },
            "color": "#343deb"
          },
          {
            "range": {
              "minimum": "50",
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": "69"
            },
            "color": "#34ebb1"
          },
          {
            "range": {
              "minimum": "69",
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": "90"
            },
            "color": "#eba834"
          },
          {
            "range": {
              "minimum": "90",
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": null
            },
            "color": "#eb3434"
          }
        ]
      }
    ]
  }
}

定義

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

BooleanRule

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

名稱	類型	Description
false	string	值為 false 時的色彩。 Color 是各種允許格式的 JSON 字串、HTML 樣式十六進位值、RGB (“、”#ff0“、”#ffff00“、”rgb (255、255、0) “) 、RGBA (”rgba (255、 255、0、1) “) 、HSL (”hsl (100、50%) “) 和 HSLA (”hsla (100,50%，50%，1) “) 。也允許預先定義的 HTML 色彩名稱，例如黃色和藍色。
true	string	值為 true 時的色彩。 Color 是各種允許格式的 JSON 字串、HTML 樣式十六進位值、RGB (“、”#ff0“、”#ffff00“、”rgb (255、255、0) “) 、RGBA (”rgba (255、 255、0、1) “) 、HSL (”hsl (100、50%) “) 和 HSLA (”hsla (100,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	錯誤物件。

NumberRule

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

名稱	類型	Description
color	string	值在範圍內時的色彩。 Color 是各種允許格式的 JSON 字串、HTML 樣式十六進位值、RGB (“、”#ff0“、”#ffff00“、”rgb (255、255、0) “) 、RGBA (”rgba (255、 255、0、1) “) 、HSL (”hsl (100、50%) “) 和 HSLA (”hsla (100,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 的所有數位 x > 。
maximum	string	x ≤最大值的所有數位 x。
minimum	string	x ≥最小值的所有數位 x。

Stateset

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

名稱	類型	Description
datasetIds	string[]	與狀態集相關聯的數據集標識碼。
description	string	與狀態集相關聯的描述。
statesetStyle	StyleRules	樣式模型。

StringStyleRule

字串類型樣式規則物件。

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

StyleRules

樣式模型。

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

共用方式為