Render - Get Map Tile

服務:

Maps

API 版本:

1.0

用來取得向量或點陣格式的地圖底圖，通常要整合到新的地圖控件或 SDK 中。

注意

Azure 地圖服務 轉譯 v1 服務淘汰

Azure 地圖服務 Render v1 服務現在已被取代，將於 9/17/26 淘汰。 為了避免服務中斷，所有轉譯 v1 API 的呼叫都必須更新為使用 轉譯 v2 API 9/17/26。

擷取向量或點陣格式的地圖底圖，通常要整合到新的地圖控件或 SDK 中。 根據預設，Azure 會針對其 Web 地圖控件使用向量地圖底圖 (請參閱 縮放層級和磚網格 線)

注意：天氣圖格僅適用於 取得地圖底圖 V2 API。 建議您開始使用新的 取得地圖底圖 V2 API。

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}

含選擇性參數:

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}&tileSize={tileSize}&language={language}&view={view}

URI 參數

名稱	位於	必要	類型	Description
format	path	True	TileFormat	所需的回應格式。 可能的值為 png & pbf。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
layer	query	True	MapTileLayer	要求的地圖圖層。 可能的值為基本、混合式、標籤和 terra。
style	query	True	MapTileStyle	要傳回的地圖樣式。 可能的值為主要、深色和shaded_relief。
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	傳回地圖底圖的大小，以像素為單位。
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	此影像會從成功的取得地圖底圖呼叫傳回 Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" 標題 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 身分識別平台 概觀。

類型: 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 地圖服務 帳戶時所佈建的共享密鑰。

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

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

類型: apiKey
位於: query

SAS Token

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

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

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

類型: apiKey
位於: header

範例

Successful Tile Request

範例要求

HTTP

GET https://atlas.microsoft.com/map/tile/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22

範例回覆

狀態碼:

200

Content-Type: image/png

"{file}"

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
LocalizedMapView	View 參數 (也稱為「用戶區域」參數) 可讓您針對特定國家/地區顯示地理政治爭議區域的正確地圖。 不同的國家/地區具有這類區域的不同檢視，而 View 參數可讓您的應用程式符合應用程式將提供服務的國家/地區所需的檢視。 根據預設，View 參數會設定為 「Unified」，即使您尚未在要求中定義它也一樣。 您必須負責判斷使用者的位置，然後正確設定該位置的 View 參數。 或者，您可以選擇設定 'View=Auto'，這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務 中的 View 參數必須符合適用的法律，包括對應、地圖、影像和其他數據，以及您有權透過 Azure 地圖服務 存取的第三方內容的國家/地區。 範例：view=IN。 如需詳細資訊，請參閱 支援的檢視 ，並查看可用的檢視。
MapTileLayer	要求地圖圖層。 可能的值為基本、混合式、標籤和 terra。
MapTileSize	以像素為單位傳回的地圖底圖大小。
MapTileStyle	要傳回的對應樣式。 可能的值為主要、深色和shaded_relief。
TileFormat	所需的回應格式。 可能的值為 png & pbf。

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	葉門 (阿拉伯文檢視)

MapTileLayer

要求地圖圖層。 可能的值為基本、混合式、標籤和 terra。

名稱	類型	Description
basic	string	傳回包含所有地圖功能的圖格，包括多邊形、框線、道路和標籤。
hybrid	string	傳回包含框線、道路和標籤的圖格，而且可以覆寫在其他磚上 (，例如衛星影像) 來產生混合式磚。
labels	string	只傳回地圖標籤資訊的圖格。
terra	string	地圖畫布已完成，其中包含陰影地道磚。 支援縮放層級 0-6 (包容性) 。 Png 是唯一支援的 TileFormat，而且只有可用的 MapTileSize 是 512。

MapTileSize

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

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

MapTileStyle

要傳回的對應樣式。 可能的值為主要、深色和shaded_relief。

名稱	類型	Description
dark	string	Azure 地圖服務 主要樣式的深灰色版本。 PNG 是唯一支援的 TileFormat。
main	string	Azure 地圖服務 主要樣式
shaded_relief	string	Azure 地圖服務 以陰影緩和完成的主要樣式。 第 terra 層支援。

TileFormat

所需的回應格式。 可能的值為 png & pbf。

名稱	類型	Description
pbf	string	pbf 格式的向量圖形。 支援縮放層級 0 到 22。
png	string	png 格式的影像。 支援縮放層級 0 到 18。