Data - Download
使用 來下載先前使用 數據上傳上傳的數據。
注意
Azure 地圖服務數據服務淘汰
Azure 地圖服務數據服務 (v1 和 v2) 現在已被取代,將於 9/16/24 淘汰。 為了避免服務中斷,所有對數據服務的呼叫都必須更新,才能使用 9/16/24 的 Azure 地圖服務 數據登錄 服務。 如需詳細資訊,請參閱 如何建立數據登錄。
Data Download
API 是 和 HTTP GET
要求,可讓呼叫端下載先前上傳的數據內容。
您可以在下載先前使用 數據上傳 API 上傳的現有地理柵欄集合來在我們的 Azure 地圖服務地理柵欄服務中使用的案例中使用此 API。
重要
使用這項功能,即表示您同意預覽法律條款。 如需其他詳細數據,請參閱 預覽補充條款 。
提交下載要求
若要下載內容,您將使用 GET
路徑將包含 udid
要下載之數據的要求。 您也可以選擇性地傳入 Accept
標頭,以指定數據回應的 喜好 Content-Type
設定。
例如,若要下載先前使用上傳 API 上傳的地理柵欄集合,請在上傳 API 回應中先前收到的數據路徑udid
中設定 udid
參數,並將標頭設定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 地圖服務建立者資源所在的位置。 有效值為us和 eu。 |
udid
|
path | True |
string |
內容的唯一數據識別碼。
|
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
x-ms-client-id |
string |
指定哪一個帳戶用於搭配 Microsoft Entra ID 安全性模型使用。 它代表 Azure 地圖服務帳戶的唯一標識碼,而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。 若要在 Azure 地圖服務中使用 Microsoft 專案標識碼安全性,請參閱下列 文章 以取得指引。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
file |
數據下載要求已成功完成。 回應本文將包含傳入 Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream" 標題 Content-Type: string |
Other Status Codes |
發生意外錯誤。 Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream" |
安全性
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 入口網站中 建立 Azure 地圖服務帳戶 或使用 PowerShell、CLI、Azure SDK 或 REST API 時所佈建的共用密鑰。
使用此金鑰時,任何應用程式都可以存取所有 REST API。 換句話說,此金鑰可作為發行帳戶中的主要金鑰。
對於公開的應用程式,我們建議使用 機密用戶端應用程式 方法來存取 Azure 地圖服務 REST API,以便安全地儲存您的密鑰。
類型:
apiKey
位於:
query
SAS Token
這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 地圖服務資源 上的清單 SAS 作業建立共用存取簽章令牌。
使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並精細控制到期、速率和區域 (特定令牌的使用) 。 換句話說,SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式控制存取。
對於公開的應用程式,我們建議在 地圖帳戶資源 上設定允許的來源特定清單,以限制轉譯濫用,並定期更新 SAS 令牌。
類型:
apiKey
位於:
header
範例
Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences
範例要求
GET https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2.0
範例回覆
"{file}"
定義
名稱 | Description |
---|---|
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |