Render - Get Map Attribution
使用 取得地圖版權屬性資訊。
Get Map Attribution API 可讓使用者要求圖格集區段的地圖版權屬性資訊。
GET {endpoint}/map/attribution?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&bounds={bounds}
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Azure 地圖服務 服務的主機名稱。 Azure公有雲用 |
|
api-version
|
query | True |
string minLength: 1 |
用於此作業的 API 版本。 |
|
bounds
|
query | True |
number[] |
字串,表示周框方塊的矩形區域。 界限參數是由 4 個周框方塊座標所定義,其中西南角的 WGS84 經度和緯度,後面接著東北角的 WGS84 經度和緯度。 字串會以下欄格式呈現: |
|
tileset
|
query | True |
地圖底圖集是點陣或向量資料的集合,分為預設縮放層級的方形地圖底圖統一方格。 每個磚集都有一個 tilesetId,以在提出要求時使用。 Azure 地圖服務提供的現成圖塊集如下。 例如,microsoft.base。 |
|
|
zoom
|
query | True |
integer (int32) |
所需地圖屬性的縮放層級。 |
要求標頭
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| x-ms-client-id |
string |
表示該帳號用於 Microsoft Entra ID 安全模型。 這個Azure 地圖服務帳號的唯一 ID 可以從 Azure 地圖服務 管理平面的 Account API 取得。 欲了解更多在Azure 地圖服務中使用Microsoft Entra ID安全,請參見管理 Azure 地圖服務 認證。 |
回覆
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
要求已成功。 |
|
| Other Status Codes |
未預期的錯誤回應。 |
安全性
AadToken
這些是Microsoft Entra OAuth 2.0流。 當與 Azure 基於角色的存取 控制結合時,可以用來控制對 Azure 地圖服務 REST API 的存取。 Azure 角色基礎存取控制用於指定對一個或多個 Azure 地圖服務 資源帳號或子資源的存取權限。 任何使用者、群組或服務主體都可以透過內建角色或由一或多個 Azure 地圖服務 REST API 許可權所組成的自定義角色來授與存取權。
若要實作案例,建議您檢視
Note
- 此安全性定義 需要 使用
x-ms-client-id標頭來指出應用程式要求存取的 Azure 地圖服務資源。 這可以從 地圖管理 API取得。 -
Authorization URL專屬於 Azure 公用雲端實例。 主權雲擁有獨特的授權網址和 Microsoft Entra ID 設定。 - Azure 角色型訪問控制是從 azure 管理平面 設定, 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API。
- Azure 地圖服務 Web SDK 的使用,可讓您針對多個使用案例設定應用程式。
- 如需Microsoft身分識別平臺的詳細資訊,請參閱 Microsoft 身分識別平臺概觀。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
| 名稱 | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
這是當您 在 Azure 入口網站或使用 PowerShell、CLI、Azure SDK 或 REST API 建立 Azure 地圖服務帳戶時所佈建的共用密鑰。
使用此金鑰,任何應用程式都可以存取所有 REST API。 換句話說,此金鑰可用來做為帳戶中核發的主要密鑰。
針對公開的應用程式,我們建議使用 機密用戶端應用程式 方法來存取 Azure 地圖服務 REST API,以便安全地儲存您的密鑰。
類型:
apiKey
位於:
header
SAS Token
這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 azure 地圖服務資源
使用此令牌時,任何應用程式都有權使用 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 |
所有 Azure Resource Manager API 的常見錯誤回應,用於回傳失敗操作的錯誤細節。 (這也遵循 OData 錯誤回應格式。)。 |
|
Map |
圖格集所要求區段的著作權屬性。 |
| TilesetID |
地圖底圖集是點陣或向量資料的集合,分為預設縮放層級的方形地圖底圖統一方格。 每個磚集都有一個 tilesetId,以在提出要求時使用。 Azure 地圖服務提供的現成圖塊集如下。 例如,microsoft.base。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| info |
其他資訊。 |
|
| type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalInfo |
錯誤其他資訊。 |
|
| code |
string |
錯誤碼。 |
| details |
錯誤詳情 |
|
| message |
string |
錯誤訊息。 |
| target |
string |
錯誤目標。 |
ErrorResponse
所有 Azure Resource Manager API 的常見錯誤回應,用於回傳失敗操作的錯誤細節。 (這也遵循 OData 錯誤回應格式。)。
| 名稱 | 類型 | Description |
|---|---|---|
| error |
error 物件。 |
MapAttribution
圖格集所要求區段的著作權屬性。
| 名稱 | 類型 | Description |
|---|---|---|
| copyrights |
string[] |
著作權字串清單。 |
TilesetID
地圖底圖集是點陣或向量資料的集合,分為預設縮放層級的方形地圖底圖統一方格。 每個磚集都有一個 tilesetId,以在提出要求時使用。 Azure 地圖服務提供的現成圖塊集如下。 例如,microsoft.base。
| 值 | Description |
|---|---|
| microsoft.base |
基本地圖是標準地圖,可顯示道路、自然和人工特徵,以及向量圖格中這些功能的標籤。 支援縮放層級 0 到 22。 格式:向量(pbf)。 |
| microsoft.base.labels |
在向量磚中顯示道路、自然和人工特徵的標籤。 支援縮放層級 0 到 22。 格式:向量(pbf)。 |
| microsoft.base.hybrid |
在向量磚中顯示道路、界限和標籤數據。 支援縮放層級 0 到 22。 格式:向量(pbf)。 |
| microsoft.terra.main |
陰影浮雕和 terra 層次。 支援縮放層級 0 到 6。 格式:點陣(png)。 |
| microsoft.base.road |
具有主要樣式的所有圖層。 支援縮放層級 0 到 22。 格式:點陣(png)。 |
| microsoft.base.darkgrey |
具有深灰色樣式的所有圖層。 支援縮放層級 0 到 22。 格式:點陣(png)。 |
| microsoft.base.labels.road |
在主要樣式中標記數據。 支援縮放層級 0 到 22。 格式:點陣(png)。 |
| microsoft.base.labels.darkgrey |
以深灰色樣式標記數據。 支援縮放層級 0 到 22。 格式:點陣(png)。 |
| microsoft.base.hybrid.road |
主要樣式中的道路、界限和標籤數據。 支援縮放層級 0 到 22。 格式:點陣(png)。 |
| microsoft.base.hybrid.darkgrey |
我們的深灰色樣式中的道路、界限和標籤數據。 支援縮放層級 0 到 22。 格式:點陣(png)。 |
| microsoft.imagery |
衛星或空中影像的組合。 支援縮放層級 1 到 19。 格式:點陣(png)。 |
| microsoft.weather.radar.main |
天氣雷達圖格。 最新的天氣雷達影像,包括雨、雪、冰和混合條件。 欲了解更多Azure 地圖服務氣象服務報導資訊,請參閱 Azure 地圖服務 天氣服務報導。 欲了解更多雷達資料資訊,請參閱Azure 地圖服務<>中的 支援縮放層級 0 到 15。 格式:點陣(png)。 |
| microsoft.weather.infrared.main |
天氣紅外磚。 最新的紅外衛星圖像會依其溫度顯示雲層。 欲了解更多資訊,請參閱Azure 地圖服務氣象服務報導。 欲了解更多衛星資料資訊,請參閱氣象服務Azure 地圖服務。 支援縮放層級 0 到 15。 格式:點陣(png)。 |
| microsoft.traffic.absolute |
向量中的絕對流量磚 |
| microsoft.traffic.absolute.main |
我們主要樣式中點陣中的絕對交通圖格。 |
| microsoft.traffic.relative |
向量中的相對流量磚 |
| microsoft.traffic.relative.main |
我們主要樣式中點陣中的相對交通圖格。 |
| microsoft.traffic.relative.dark |
在我們的深色樣式中,點陣中的相對交通圖格。 |
| microsoft.traffic.delay |
向量中的流量圖格 |
| microsoft.traffic.delay.main |
主要樣式中點陣中的交通圖格 |
| microsoft.traffic.reduced.main |
減少以點陣為主樣式的交通圖格 |
| microsoft.traffic.incident |
向量中的事件磚 |