Dataset - Create
使用 來建立數據集。
備註
Azure 地圖服務 Creator 淘汰
Azure 地圖服務 Creator 室內地圖服務現在已被取代,且將於 2025/9/30 淘汰。 如需詳細資訊,請參閱 Azure 地圖服務 Creator 的生命周期結束公告。
Create
API 是一項 HTTP POST
要求,會接受已轉換繪圖套件的 conversionId
值,並傳回新建立數據集的 datasetId
屬性。 如需詳細資訊,請參閱 建立資料集。
您可以在上傳建築物的 DWG zip 套件、使用 Azure 地圖服務 轉換 服務轉換 zip 套件,以及從轉換的 zip 套件建立數據集等案例中使用此要求。 建立的數據集可用來使用 Azure 地圖服務 地圖底圖集 服務來建立圖格集,並可透過 Azure 地圖服務 WFS 服務進行查詢。
提交建立要求
若要建立數據集,您將使用 POST
要求,其中 conversionId
查詢參數是代表已轉換 DWG zip 套件的識別碼,datasetId
參數是先前建立的數據集標識符,以附加目前數據集,而且選擇性地,description
查詢參數將包含描述(如果未提供描述,則會提供預設描述)。
建立 API 是 長時間執行的作業。
POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}
POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}&datasetId={datasetId}&description={description}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
geography
|
path | True |
string |
此參數會指定 Azure 地圖服務建立者資源所在的位置。 有效值為我們和 eu。 |
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 |
conversion
|
query | True |
string |
用來建立數據集的唯一標識符。
|
dataset
|
query |
string |
要附加之數據集的標識碼。 數據集必須源自符合 datasetId 的先前數據集建立呼叫 |
|
description
|
query |
string |
要提供給數據集的描述。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
x-ms-client-id |
string |
指定要與 Microsoft Entra ID 安全性模型搭配使用的帳戶。 它代表 Azure 地圖服務帳戶的唯一標識碼,而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。 若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性,請參閱下列 文章 以取得指引。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
作業正在執行或完成。 如果作業成功,請使用 Resource-Location 標頭來取得結果的路徑。 標題 Resource-Location: string |
|
202 Accepted |
要求已接受:要求已接受進行處理。 請使用 Operation-Location 標頭中的 URL 來取得狀態。 標題 Operation-Location: string |
|
Other Status Codes |
發生未預期的錯誤。 |
安全性
AADToken
這些是 Entra OAuth 2.0 流程
若要實作案例,建議您檢視
備註
- 此安全性定義 需要 使用
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 地圖服務帳戶時所佈建的共用密鑰。
使用此金鑰,任何應用程式都可以存取所有 REST API。 換句話說,此金鑰可用來做為帳戶中核發的主要密鑰。
針對公開的應用程式,我們建議使用 機密用戶端應用程式 方法來存取 Azure 地圖服務 REST API,以便安全地儲存您的密鑰。
類型:
apiKey
位於:
query
SAS Token
這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 azure 地圖服務資源
使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並更精細地控制特定令牌的到期、速率和區域。 換句話說,SAS 令牌可用來讓應用程式以比共用密鑰更安全的方式控制存取。
對於公開的應用程式,我們建議在 對應帳戶資源上設定允許的來源特定清單, 以限制轉譯濫用,並定期更新 SAS 令牌。
類型:
apiKey
位於:
header
範例
Create dataset from a converted CAD file provided by conversionId
範例要求
POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]
範例回覆
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
{
"operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"created": "2021-04-20T22:43:14.9401559+00:00",
"status": "Succeeded"
}
Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location
定義
名稱 | Description |
---|---|
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Long |
Long-Running Operations API 的回應模型。 |
Lro |
要求的狀態狀態。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細數據。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
LongRunningOperationResult
Long-Running Operations API 的回應模型。
名稱 | 類型 | Description |
---|---|---|
created |
string (date-time) |
建立的時間戳。 |
error |
錯誤詳細數據。 |
|
operationId |
string |
此長時間執行作業的識別碼。 |
status |
要求的狀態狀態。 |
|
warning |
錯誤詳細數據。 |
LroStatus
要求的狀態狀態。
值 | Description |
---|---|
Failed |
要求有一或多個失敗。 |
NotStarted |
要求尚未開始處理。 |
Running |
要求已開始處理。 |
Succeeded |
要求已順利完成。 |