Share via

Data - Download

  • 參考
Service:
Maps
API Version:
2.0

用來下載先前使用 數據上傳上傳的數據。

注意

Azure 地圖服務 數據服務淘汰

Azure 地圖服務 數據服務 (v1 和 v2) 現在已被取代，將於 9/16/24 淘汰。 若要避免服務中斷，所有對數據服務的呼叫都必須更新，才能使用 9/16/24 Azure 地圖服務 Data Registry 服務。 如需詳細資訊，請參閱 如何建立數據登錄。

Data Download API 是 和 HTTP GET 要求，可讓呼叫端下載先前上傳的數據內容。

您可以在案例中使用此 API，例如下載先前使用數據上傳 API 上傳的現有地理柵欄集合，以用於我們的 Azure 地圖服務 地理柵欄服務。

重要

使用這項功能，即表示您同意預覽法律條款。 如需詳細資訊，請參閱 預覽補充條款 。

提交下載要求

若要下載您的內容，您將使用 GET 路徑將包含 udid 要下載之數據的要求。 您也可以選擇性地傳入 Accept 標頭，以指定數據回應的 喜好 Content-Type 設定。

例如，若要下載先前使用上傳 API 上傳的地理柵欄集合，請將參數設定 udid 為 udid 先前在上傳 API 回應中收到的數據路徑中的 參數，並將標頭設定 Accept 為下列其中一種媒體類型：

  • application/json
  • application/vnd.geo+json
  • application/octet-stream

下載數據回應

如果找到傳入udid的數據資源，則下載 API 會傳回 HTTP 200 OK 回應，其中回應本文會包含數據資源的內容。

如果找不到傳入udid的數據資源，則會傳回 HTTP 400 Bad Request 錯誤回應。

以下是先前使用上傳 API 上傳之 GeoJSON 簡單地理柵欄的範例回應本文：

{
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-122.126986, 47.639754]
        },
        "properties": {
            "geometryId": "001",
            "radius": 500
        }
    }]
}

GET https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=2.0

URI 參數

名稱 位於 必要 類型 Description
geography
 path True

string

此參數會指定 Azure 地圖服務 Creator 資源所在的位置。 有效值為us和 eu。
udid
 path True

string

內容的唯一數據識別碼。 udid必須已從成功的資料上傳呼叫取得 。
api-version
 query True

string

Azure 地圖服務 API 的版本號碼。

要求標頭

名稱 必要 類型 Description
x-ms-client-id

string

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

回應

名稱 類型 Description
200 OK

file

數據下載要求已順利完成。 回應本文將包含傳入 udid之的內容。

Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

Headers

Content-Type: string
Other Status Codes

ErrorResponse

發生意外錯誤。

Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream"

安全性

AADToken

這些是 Microsoft Entra OAuth 2.0 流程。 與 Azure 角色型存取控制配對時，可用來控制對 #DDA283BD5D63B47E3857C65D17473292D 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 的使用方式允許針對多個使用案例設定應用程式設定。

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 入口網站 或使用PowerShell、CLI、Azure SDK 或 REST API Create Azure 地圖服務 帳戶時所佈建的共用金鑰。

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

範例

Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences

Sample Request

GET https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2.0

Sample Response

Status code:
200 
"{file}"

定義

名稱 Description
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ErrorDetail

錯誤詳細數據。
ErrorResponse

錯誤回應

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳細資料。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

錯誤物件。