Render - Get Map State Tile

服務:

Maps

API 版本:

2024-04-01

用來取得向量格式的狀態圖格，然後可用來在室內地圖中顯示特徵狀態資訊。

擷取向量格式的狀態圖格通常會整合到地圖控件或 SDK 的室內地圖模組中。 用戶開啟動態樣式之後，地圖控件會呼叫此 API。 如需詳細資訊，請參閱 縮放層級和磚方格。

GET https://atlas.microsoft.com/map/statetile?api-version=2024-04-01&zoom={zoom}&x={x}&y={y}&statesetId={statesetId}

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。 目前的版本是 2024-04-01。
statesetId	query	True	string	狀態集標識碼。
x	query	True	integer int32	縮放方格上磚的 X 座標。 值必須位於 [0， 2zoom -1] 範圍內。 如需詳細資訊，請參閱 縮放層級和磚網格 線。
y	query	True	integer int32	縮放方格上磚的 Y 座標。 值必須位於 [0， 2zoom -1] 範圍內。 如需詳細資訊，請參閱 縮放層級和磚網格 線。
zoom	query	True	integer int32	所需磚的縮放層級。 如需詳細資訊，請參閱 縮放層級和磚網格 線。

要求標頭

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

回應

名稱	類型	Description
200 OK	object	從成功的取得地圖狀態磚呼叫傳回此圖格 Media Types: "application/vnd.mapbox-vector-tile", "application/json" 標題 Content-Type: string
Other Status Codes	ErrorResponse	發生意外錯誤。 Media Types: "application/vnd.mapbox-vector-tile", "application/json"

安全性

AADToken

這些是 entra OAuth 2.0 Flow Microsoft 。 與 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 透過 Azure 管理平面建立 Azure 地圖服務資源 時所佈建的共用密鑰。

使用此金鑰時，任何應用程式都會獲得存取所有 REST API 的授權。 換句話說，這些目前可視為發行帳戶的主要密鑰。

對於公開的應用程式，我們建議使用 Azure 地圖服務 REST API 的伺服器對伺服器存取，以便安全地儲存此密鑰。

類型: apiKey
位於: header

SAS Token

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

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

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

類型: apiKey
位於: header

範例

Successful State Tile Request

範例要求

HTTP

GET https://atlas.microsoft.com/map/statetile?api-version=2024-04-01&zoom=6&x=10&y=22&statesetId=[statesetId]

範例回覆

狀態碼:

200

Content-Type: application/vnd.mapbox-vector-tile

"{file}"

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。