Render - Get Map Tile

Service:

Maps

API Version:

2022-08-01

使用 以向量或點陣格式要求地圖底圖。
**

Get Map Tiles API 是 HTTP GET 要求，可讓使用者以向量或點陣格式要求地圖底圖，通常要整合到地圖控件或 SDK 中。 您可以要求的一些範例磚是 Azure 地圖服務 道路圖格、實時天氣雷達圖格，或使用 Azure 地圖服務 Creator 建立的地圖底圖。 根據預設，Azure 地圖服務 會針對其 Web 地圖控件使用向量圖格， (Web SDK) 和 Android SDK。

GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}

With optional parameters:

GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。 目前的版本為 2022-08-01
tilesetId	query	True	TilesetID	地圖底圖集是點陣或向量資料的集合，分為預設縮放層級的方形地圖底圖統一方格。 每個磚集都有 一個 tilesetId ，用於提出要求。 使用 Azure 地圖服務 Creator 建立之磚集的 tilesetId 是透過 Tileset Create API 產生。 下面列出 Azure 地圖服務 提供的現成可用的磚集。 例如，microsoft.base。
x	query	True	integer int32	縮放方格上磚的 X 座標。 值必須介於 [0， 2zoom -1] 的範圍內。 如需詳細資訊，請參閱 縮放層級和磚網格線 。
y	query	True	integer int32	縮放方格上磚的 Y 座標。 值必須介於 [0， 2zoom -1] 的範圍內。 如需詳細資訊，請參閱 縮放層級和磚網格線 。
zoom	query	True	integer int32	所需磚的縮放層級。 如需詳細資訊，請參閱 縮放層級和磚網格線 。
language	query		string	應該傳回搜尋結果的語言。 應該是其中一個支援的 IETF 語言標記，不區分大小寫。 當特定欄位無法使用指定語言的數據時，會使用預設語言。 如需詳細資訊，請參閱 支援的語言 。
tileSize	query		MapTileSize	傳回地圖底圖的大小，以像素為單位。
timeStamp	query		string date-time	所要求磚的所需日期和時間。 此參數必須以標準日期時間格式指定 (，例如 2019-11-14T16：03：00-08：00) ，如 ISO 8601 所定義。 只有在 tilesetId 參數設定為下列其中一個值時，才支援此參數。 microsoft.weather.infrared.main：我們提供過去最多 3 小時的磚。 磚的間隔為10分鐘。 我們會將 timeStamp 值四捨五入到最接近的 10 分鐘時間範圍。 microsoft.weather.radar.main：我們提供過去最多 1.5 小時的磚，未來最多 2 小時。 磚的間隔為 5 分鐘。 我們會將 timeStamp 值四捨五入到最接近的 5 分鐘時間範圍。
view	query		LocalizedMapView	View 參數 (也稱為「用戶區域」參數) 可讓您針對特定國家/地區顯示地緣政治爭議區域的正確地圖。 不同的國家/地區具有這類區域的不同檢視，而 View 參數可讓應用程式符合應用程式將提供服務的國家/地區所需的檢視。 根據預設，即使您尚未在要求中定義 View 參數，View 參數也會設定為 “Unified”。 您必須負責判斷使用者的位置，然後正確設定該位置的 View 參數。 或者，您可以選擇設定 'View=Auto'，這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務 中的 View 參數必須符合適用的法律，包括地圖、影像和其他數據，以及您透過 Azure 地圖服務 授權存取的第三方內容的國家/地區相關對應。 範例：view=IN。 如需詳細資訊，請參閱 支援的檢視 ，並查看可用的檢視。

要求標頭

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

回應

名稱	類型	Description
200 OK	object	從成功的 API 呼叫傳回的圖格。 Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string
Other Status Codes	ErrorResponse	發生意外錯誤。 Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

安全性

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 身分識別平台 概觀。

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 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API 建立 Azure 地圖服務 資源時所佈建的共用密鑰。

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

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

Type: apiKey
In: header

SAS Token

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

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

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

Type: apiKey
In: header

範例

Successful Tile Request

Sample Request

HTTP

GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId=microsoft.base&zoom=6&x=10&y=22

Sample Response

Status code:

200

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

Response Body

"binary image string"

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
LocalizedMapView	View 參數 (也稱為「用戶區域」參數) 可讓您針對特定國家/地區顯示地理政治爭議區域的正確地圖。 不同的國家/地區具有這類區域的不同檢視，而 View 參數可讓您的應用程式符合應用程式將提供服務的國家/地區所需的檢視。 根據預設，View 參數會設定為 「Unified」，即使您尚未在要求中定義它也一樣。 您必須負責判斷使用者的位置，然後正確設定該位置的 View 參數。 或者，您可以選擇設定 'View=Auto'，這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務 中的 View 參數必須符合適用的法律，包括對應、地圖、影像和其他數據，以及您有權透過 Azure 地圖服務 存取的第三方內容的國家/地區。 範例：view=IN。 如需詳細資訊，請參閱 支援的檢視 ，並查看可用的檢視。
MapTileSize	以像素為單位傳回的地圖底圖大小。
TilesetID	地圖底圖集是點陣或向量資料的集合，分為預設縮放層級的方形地圖底圖統一方格。 每個磚 集都有一個 tilesetId ，在提出要求時使用。 使用 Azure 地圖服務 Creator 建立之磚集的 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	error 物件。

LocalizedMapView

View 參數 (也稱為「用戶區域」參數) 可讓您針對特定國家/地區顯示地理政治爭議區域的正確地圖。 不同的國家/地區具有這類區域的不同檢視，而 View 參數可讓您的應用程式符合應用程式將提供服務的國家/地區所需的檢視。 根據預設，View 參數會設定為 「Unified」，即使您尚未在要求中定義它也一樣。 您必須負責判斷使用者的位置，然後正確設定該位置的 View 參數。 或者，您可以選擇設定 'View=Auto'，這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務 中的 View 參數必須符合適用的法律，包括對應、地圖、影像和其他數據，以及您有權透過 Azure 地圖服務 存取的第三方內容的國家/地區。 範例：view=IN。

如需詳細資訊，請參閱 支援的檢視 ，並查看可用的檢視。

名稱	類型	Description
AE	string	阿拉伯聯合大公國 (阿拉伯文檢視)
AR	string	阿根廷 (阿根廷文檢視)
Auto	string	根據要求的 IP 位址傳回地圖資料。
BH	string	巴林 (阿拉伯文檢視)
IN	string	印度 (印度文檢視)
IQ	string	伊拉克 (阿拉伯文檢視)
JO	string	約旦 (阿拉伯文檢視)
KW	string	科威特 (阿拉伯文檢視)
LB	string	黎巴嫩 (阿拉伯文檢視)
MA	string	摩洛哥 (摩洛哥文檢視)
OM	string	阿曼 (阿拉伯文檢視)
PK	string	巴基斯坦 (巴基斯坦文檢視)
PS	string	巴勒斯坦民族權力機構 (阿拉伯文檢視)
QA	string	卡達 (阿拉伯文檢視)
SA	string	沙烏地阿拉伯 (阿拉伯文檢視)
SY	string	敘利亞 (阿拉伯文檢視)
Unified	string	整合檢視 (其他)
YE	string	葉門 (阿拉伯文檢視)

MapTileSize

以像素為單位傳回的地圖底圖大小。

名稱	類型	Description
256	string	傳回 256 x 256 像素磚。
512	string	傳回 512 x 512 像素磚。

TilesetID

地圖底圖集是點陣或向量資料的集合，分為預設縮放層級的方形地圖底圖統一方格。 每個磚 集都有一個 tilesetId ，在提出要求時使用。 使用 Azure 地圖服務 Creator 建立之磚集的 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 地圖服務 天氣服務的涵蓋範圍資訊。 若要深入瞭解傳回的衛星數據，請參閱 天氣概念。 支援縮放層級 0 到 15。 格式：點陣 (png) 。
microsoft.weather.radar.main	string	天氣雷達圖格。 最新的天氣雷達圖，包括雨、雪、雪和混合條件的區域。 請參閱 Azure 地圖服務 天氣服務的涵蓋範圍資訊。 若要深入瞭解雷達圖數據，請參閱 天氣概念。 支援縮放層級 0 到 15。 格式：點陣 (png) 。