Render - Get Map Attribution
使用 取得地圖著作權屬性資訊。
Get Map Attribution
API 可讓使用者要求圖格集區段的地圖著作權屬性資訊。
GET https://atlas.microsoft.com/map/attribution?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&bounds={bounds}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 目前的版本為 2024-04-01。 |
bounds
|
query | True |
number[] |
字串,表示周框方塊的矩形區域。 bounds 參數是由 4 個周框方塊座標所定義,其中 WGS84 經度和緯度是西角的 WGS84 經度和緯度,後面接著 WGS84 經度和北角的緯度。 字串會以下列格式呈現: |
tileset
|
query | True |
地圖底圖集是點陣或向量資料的集合,分為預設縮放層級的方形地圖底圖統一方格。 每個磚集都有 一個 tilesetId ,用於提出要求。 使用 Azure 地圖服務建立工具建立之地圖底圖集的 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 專案標識碼安全性,請參閱下列 文章 以取得指引。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 |
|
Other Status Codes |
發生意外錯誤。 |
安全性
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 Attribution Request
範例要求
GET https://atlas.microsoft.com/map/attribution?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&bounds=-122.414162,47.57949,-122.247157,47.668372
範例回覆
{
"copyrights": [
"<a data-azure-maps-attribution-tileset=\"microsoft.base\">©2022 TomTom</a>"
]
}
定義
名稱 | Description |
---|---|
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Map |
圖格集所要求區段的著作權屬性。 |
TilesetID |
地圖底圖集是點陣或向量資料的集合,分為預設縮放層級的方形地圖底圖統一方格。 每個磚 集都有一個 tilesetId ,在提出要求時使用。 使用 Azure 地圖服務建立者建立之磚集的 tilesetId 是透過磚集建立 API 產生。 Azure 地圖服務所提供的現成使用圖格集如下所列。 例如,microsoft.base。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
MapAttribution
圖格集所要求區段的著作權屬性。
名稱 | 類型 | Description |
---|---|---|
copyrights |
string[] |
著作權字串的清單。 |
TilesetID
地圖底圖集是點陣或向量資料的集合,分為預設縮放層級的方形地圖底圖統一方格。 每個磚 集都有一個 tilesetId ,在提出要求時使用。 使用 Azure 地圖服務建立者建立之磚集的 tilesetId 是透過磚集建立 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) 。 |