Render - Get Map Tileset

參考

服務:: Maps

API 版本:: 2024-04-01

用來取得磚集的元數據。

取得地圖底圖集 API 可讓使用者要求地圖底圖集的元數據。

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。目前的版本為 2024-04-01。
tilesetId	query	True	TilesetID	地圖底圖集是點陣或向量資料的集合，分為預設縮放層級的方形地圖底圖統一方格。每個磚集都有一個 tilesetId ，用於提出要求。使用 Azure 地圖服務建立工具建立之地圖底圖集的 tilesetId 是透過 Tileset Create API 產生。下面列出 Azure 地圖服務所提供的現成可用的地圖底圖集。例如，microsoft.base。

要求標頭

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

回應

名稱	類型	Description
200 OK	MapTileset	確定
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 透過 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 Tileset Request

範例要求

HTTP

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base

範例回覆

狀態碼:: 200

{
  "tilejson": "2.2.0",
  "version": "1.0.0",
  "attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">&copy;2022 TomTom</a>",
  "scheme": "xyz",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
  ],
  "minzoom": 0,
  "maxzoom": 22,
  "bounds": [
    -180,
    -90,
    180,
    90
  ]
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
MapTileset	TileJSON 格式磚集的元數據。
TilesetID	地圖底圖集是點陣或向量資料的集合，分為預設縮放層級的方形地圖底圖統一方格。每個磚集都有一個 tilesetId ，用於提出要求。使用 Azure 地圖服務建立工具建立之地圖底圖集的 tilesetId 是透過 Tileset Create API 產生。下面列出 Azure 地圖服務所提供的現成可用的地圖底圖集。例如，microsoft.base。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

MapTileset

TileJSON 格式磚集的元數據。

名稱	類型	Description
attribution	string	要在地圖上顯示的著作權屬性。實作可能會決定將此視為 HTML 或常值文字。基於安全性考慮，請確定此字段無法濫用為 XSS 或指標追蹤的向量。
bounds	number[]	可用地圖底圖的最大範圍。界限必須定義所有縮放層級所涵蓋的區域。界限以 WGS：84 緯度和經度值表示，順序為左、下、右、上。值可以是整數或浮點數。
center	number[]	圖格集的預設位置，格式為 [經度、緯度、縮放]。縮放層級必須介於minzoom和 maxzoom之間。實作可以使用此值來設定預設位置。
data	string[]	GeoJSON 格式的數據檔陣列。
description	string	圖格集的文字描述。描述可以包含任何法律字元。實作「不應該」將描述解譯為 HTML。
grids	string[]	互動端點的陣列。
legend	string	要與地圖一起顯示的圖例。實作可能會決定將此視為 HTML 或常值文字。基於安全性考慮，請確定此字段無法濫用為 XSS 或指標追蹤的向量。
maxzoom	integer	縮放層級上限。
minzoom	integer	最小縮放層級。
name	string	描述磚集的名稱。名稱可以包含任何法律字元。實作「不應該」將名稱解譯為 HTML。
scheme	string	默認值：「xyz」。 “xyz” 或 “tms”。影響磚座標的 Y 方向。假設 global-mercator (也稱為 Spherical Mercator) 配置檔。
template	string	要用來格式化方格中數據以進行互動的ache 範本。
tilejson	string	描述此 JSON 物件所實作的 TileJSON 規格版本。
tiles	string[]	磚端點的陣列。如果指定多個端點，用戶端可以使用任何端點組合。所有端點都必須針對相同的 URL 傳回相同的內容。數位必須包含至少一個端點。
version	string	磚集內所含磚的 semver.org 樣式版本號碼。引進磚之間的變更時，次要版本必須變更。

TilesetID

地圖底圖集是點陣或向量資料的集合，分為預設縮放層級的方形地圖底圖統一方格。每個磚集都有 一個 tilesetId ，用於提出要求。使用 Azure 地圖服務建立工具建立之地圖底圖集的 tilesetId 是透過 Tileset Create API 產生。下面列出 Azure 地圖服務所提供的現成可用的地圖底圖集。例如，microsoft.base。

名稱	類型	Description
microsoft.base	string	基準地圖是標準地圖，可顯示道路、自然和人工特徵，以及向量圖格中這些功能的標籤。支援縮放層級 0 到 22。格式：vector (pbf) 。
microsoft.base.darkgrey	string	具有深灰色樣式的所有圖層。支援縮放層級 0 到 22。格式：點陣 (png) 。
microsoft.base.hybrid	string	在向量磚中顯示道路、界限和標籤數據。支援縮放層級 0 到 22。格式：vector (pbf) 。
microsoft.base.hybrid.darkgrey	string	深灰色樣式中的道路、界限和標籤數據。支援縮放層級 0 到 22。格式：點陣 (png) 。
microsoft.base.hybrid.road	string	我們主要樣式中的道路、界限和標籤數據。支援縮放層級 0 到 22。格式：點陣 (png) 。
microsoft.base.labels	string	在向量磚中顯示道路、自然和人工特徵的標籤。支援縮放層級 0 到 22。格式：vector (pbf) 。
microsoft.base.labels.darkgrey	string	以深灰色樣式標記數據。支援縮放層級 0 到 22。格式：點陣 (png) 。
microsoft.base.labels.road	string	在我們的主要樣式中標記數據。支援縮放層級 0 到 22。格式：點陣 (png) 。
microsoft.base.road	string	具有我們主要樣式的所有圖層。支援縮放層級 0 到 22。格式：點陣 (png) 。
microsoft.imagery	string	衛星和空照圖影像的組合。僅適用於 S1 定價 SKU。支援縮放層級 1 到 19。格式：點陣 (jpeg) 。
microsoft.terra.main	string	陰影浮點和 terra 層。支援縮放層級 0 到 6。格式：點陣 (png) 。
microsoft.traffic.absolute	string	向量中的絕對流量磚
microsoft.traffic.absolute.main	string	我們主要樣式中點陣的絕對交通圖格。
microsoft.traffic.delay	string	向量中的交通圖格
microsoft.traffic.delay.main	string	主要樣式中點陣中的交通圖格
microsoft.traffic.incident	string	向量中的事件磚
microsoft.traffic.reduced.main	string	在主要樣式中減少點陣的交通圖格
microsoft.traffic.relative	string	向量中的相對流量圖格
microsoft.traffic.relative.dark	string	深色樣式中點陣的相對交通圖格。
microsoft.traffic.relative.main	string	我們主要樣式中點陣的相對交通圖格。
microsoft.weather.infrared.main	string	天氣基礎結構磚。最新的基礎結構衛星影像會依其溫度顯示雲端。如需詳細資訊，請參閱 Azure 地圖服務的天氣服務涵蓋範圍。如需傳回衛星數據的詳細資訊，請參閱 Azure 地圖服務中的天氣服務。支援縮放層級 0 到 15。格式：點陣 (png) 。
microsoft.weather.radar.main	string	天氣雷達圖格。最新的天氣雷達圖影像，包括雨、雪、雪和混合條件的區域。如需 Azure 地圖服務氣象服務涵蓋範圍的詳細資訊，請參閱 Azure 地圖服務氣象服務涵蓋範圍。如需雷達圖數據的詳細資訊，請參閱 Azure 地圖服務中的天氣服務。支援縮放層級 0 到 15。格式：點陣 (png) 。

共用方式為