Render - Get Map Attribution
用來取得地圖著作權屬性資訊。
Get Map Attribution
API 是 HTTP GET
要求,會傳回圖格集區段的地圖著作權屬性資訊,如四個周框方塊座標和縮放層級所定義。
GET https://atlas.microsoft.com/map/attribution?api-version=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&bounds={bounds}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 目前版本為 2022-08-01 |
bounds
|
query | True |
number[] |
字串,表示周框方塊的矩形區域。 bounds 參數是由 4 個周框方塊座標所定義,其中 WGS84 經度和西南部角落的緯度,後面接著 WGS84 經度和北角的緯度。 字串會以下列格式呈現: |
tileset
|
query | True |
地圖底圖集是點陣或向量資料的集合,分為預設縮放層級的方形地圖底圖統一方格。 每個磚 集都有一個 tilesetId ,在提出要求時使用。 使用 Azure 地圖服務 Creator 建立之磚集的 tilesetId 是透過 Tileset Create API 產生。 以下列出 Azure 地圖服務 提供的現成可用的磚集。 例如,microsoft.base。 |
|
zoom
|
query | True |
integer int32 |
所需地圖屬性的縮放層級。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
x-ms-client-id |
string |
指定哪個帳戶與 Microsoft Entra ID 安全性模型搭配使用。 它代表 Azure 地圖服務 帳戶的唯一標識符,而且可以從 Azure 地圖服務 管理平面帳戶 API 擷取。 若要在 Azure 地圖服務 中使用 Microsoft Entra ID 安全性,請參閱下列文章以取得指引。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 |
|
Other Status Codes |
發生意外錯誤。 |
安全性
AADToken
這些是 Microsoft Entra OAuth 2.0 流程。 與 Azure 角色型存取控制配對時,可用來控制對 #DEDB1AD63FAE44132852C4C2047E30764 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務 資源帳戶或子資源的存取權。 任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權,以 Azure 地圖服務 REST API。
若要實作案例,建議您檢視 驗證概念。 總而言之,此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件,提供將應用程式模型化 () 的解決方案。
備註
- 此安全性定義需要使用
x-ms-client-id
標頭來指出應用程式要求存取權 Azure 地圖服務 資源。 這可以從 地圖管理 API 取得。
Authorization URL
專屬於 Azure 公用雲端實例。 主權雲端具有唯一的授權 URL 和 Microsoft Entra ID 設定。
* Azure 角色型訪問控制是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API 從 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 Attribution Request
Sample Request
GET https://atlas.microsoft.com/map/attribution?api-version=2022-08-01&tilesetId=microsoft.base&zoom=6&bounds=-122.414162,47.57949,-122.247157,47.668372
Sample Response
{
"copyrights": [
"<a data-azure-maps-attribution-dynamic=\"true\" data-azure-maps-attribution-tileset=\"microsoft.core.vector\">©2024 TomTom</a>"
]
}
定義
名稱 | Description |
---|---|
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Map |
圖格集所要求區段的著作權屬性。 |
TilesetID |
地圖底圖集是點陣或向量資料的集合,分為預設縮放層級的方形地圖底圖統一方格。 每個磚集都有 一個 tilesetId ,用於提出要求。 使用 Azure 地圖服務 Creator 建立之磚集的 tilesetId 是透過 Tileset Create API 產生。 下面列出 Azure 地圖服務 所提供的現成可用的磚集。 例如,microsoft.base。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
錯誤物件。 |
MapAttribution
圖格集所要求區段的著作權屬性。
名稱 | 類型 | Description |
---|---|---|
copyrights |
string[] |
著作權字串的清單。 |
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) 。 |