Tileset - Get Configuration

參考

Service:: Maps Creator

API Version:: 2023-03-01-preview

用來取得圖格集組態。

Tileset Get Configuration 要求可讓呼叫端根據提供的數據集取得磚集組態。然後，即可使用磚集組態，使用 Tileset Create 建立自定義磚集。

建立者可讓您使用 Azure 地圖服務 API 和 SDK，根據私人室內地圖數據開發應用程式。如需適用於 Azure 地圖服務建立者的概念和工具的詳細資訊，請參閱室內地圖的建立者。

提交取得設定要求

Get Configuration API 是 HTTP GET 要求，可用來根據 'datasetId 取得磚集組態。

GET https://{geography}.atlas.microsoft.com/tilesets:fetchConfiguration?api-version=2023-03-01-preview&datasetId={datasetId}

URI 參數

名稱	位於	必要	類型	Description
geography	path	True	string	此參數會指定 Azure 地圖服務 Creator 資源所在的位置。有效值為us和 eu。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
datasetId	query	True	string	`datasetId`磚集建立 API 的唯一，用來擷取特徵來產生磚。 `datasetId`必須已從成功的資料集建立 API 呼叫取得。

要求標頭

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

回應

名稱	類型	Description
200 OK	TilesetConfiguration	成功完成磚集組態要求。回應本文包含為指定數據集產生的預設磚集組態。
Other Status Codes	ErrorResponse	發生意外錯誤。

安全性

AADToken

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

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

備註

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

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

Azure Active Directory v1.0 或 v2.0 目前支援公司、學校和來賓，但不支持個人帳戶。

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

Scopes

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

subscription-key

這是當您在 Azure 入口網站或使用 PowerShell、CLI、Azure SDK 或 REST API 中建立 Azure 地圖服務帳戶時所佈建的共享密鑰。

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

範例

Gets the tileset configuration for a given dataset

Sample Request

HTTP

GET https://us.atlas.microsoft.com/tilesets:fetchConfiguration?api-version=2023-03-01-preview&datasetId=[datasetId]

Sample Response

Status code:: 200

{
  "version": 1,
  "layers": {
    "Indoor unit": {
      "minZoom": 10,
      "maxZoom": 18,
      "features": {
        "featureClasses": [
          "unit",
          "wall"
        ],
        "filter": [
          "any",
          [
            "!=",
            [
              "get",
              "roomType"
            ],
            "conference"
          ],
          [
            ">=",
            [
              "zoom"
            ],
            12
          ]
        ]
      }
    }
  }
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
Feature	磚集組態的功能組態。
LayerObject	磚集組態的圖層物件。
TilesetConfiguration	圖格集組態最上層欄位。圖格集組態是 JSON 對象，必須包含下列最上層欄位：

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

Feature

磚集組態的功能組態。

名稱	類型	Description
featureClasses	string[]	將用來建置圖層的功能類別清單。您可以在其內部結構定義中找到有效的特徵類別。例如，設施 Ontology
filter	object	拿掉不符合模式的功能。請參閱 MapLibre 篩選表達式

LayerObject

磚集組態的圖層物件。

名稱	類型	Description
features	Feature	指定功能類別和篩選。
maxZoom	integer	要建置之圖層的最高縮放層級。
minZoom	integer	要建置之圖層的最低縮放層級。

TilesetConfiguration

圖格集組態最上層欄位。圖格集組態是 JSON 對象，必須包含下列最上層欄位：

名稱	類型	Description
layers	<string, LayerObject>	層次的名稱及其組態選項。組態圖層物件包含索引鍵/值組，將磚圖層的名稱與其設定產生關聯。針對每個索引鍵/值組，索引鍵是圖層的名稱，而此值是包含圖層組態和選項的 LayerObject。每個圖層都必須有名稱。這是最終磚集中數據圖層的唯一標識符。在任何圖格集中，每個圖層名稱都必須是唯一的。層次名稱必須是只有底線 (_) 和英数字元的字符串。每個圖層名稱的對應 LayerObject 描述該向量圖格圖層的建立方式。它會指定要擷取特徵數據的功能類別、透過縮放層級的數據精確度，以及如何轉換特徵並將其轉譯成磚。
version	integer	磚集組態使用的 Azure 地圖服務磚服務組態參考的版本。目前只允許第 1 版。使用目前版本或舊版的任何其他版本會導致錯誤。

共用方式為