Dataset - Create

參考

服務:: Maps Creator

API 版本:: 2.0

用來建立數據集。

Create API 是 HTTP POST 要求，會接受conversionId已轉換繪圖套件的值，並傳回datasetId新建立數據集的屬性。如需詳細資訊，請參閱建立數據集。

您可以在上傳建築物的 DWG zip 套件、使用 Azure 地圖服務轉換服務轉換 zip 套件，以及從轉換的 zip 套件建立數據集等案例中使用此要求。建立的數據集可用來使用 Azure 地圖服務 Tileset 服務來建立磚集，並可透過 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 地圖服務 Creator 資源所在的位置。有效值為us和 eu。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
conversionId	query	True	string	用來建立數據集的唯一標識符。必須已從成功呼叫轉換服務轉換 API 取得，`conversionId`而且如果提供多個查詢參數，) 則可能會提供多個具有相同名稱的查詢參數 (。
datasetId	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	LongRunningOperationResult	作業正在執行或完成。如果作業成功，請使用 Resource-Location 標頭來取得結果的路徑。標題 Resource-Location: string
202 Accepted		已接受要求：要求已接受進行處理。請使用 Operation-Location 標頭中的 URL 來取得狀態。標題 Operation-Location: string
Other Status Codes	ErrorResponse	發生意外錯誤。

名稱

類型

Description

200 OK

LongRunningOperationResult

作業正在執行或完成。如果作業成功，請使用 Resource-Location 標頭來取得結果的路徑。

標題

Resource-Location: string

202 Accepted

已接受要求：要求已接受進行處理。請使用 Operation-Location 標頭中的 URL 來取得狀態。

標題

Operation-Location: string

Other Status Codes

ErrorResponse

發生意外錯誤。

安全性

AADToken

這些是 OAuth 2.0 流程 Microsoft Entra。與 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 地圖服務帳戶時所佈建的共用密鑰。

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

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

類型: apiKey
位於: query

SAS Token

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

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

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

類型: apiKey
位於: header

範例

Create dataset from a converted CAD file provided by conversionId

範例要求

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]

範例回覆

狀態碼:: 200

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"
}

狀態碼:: 202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
LongRunningOperationResult	Long-Running Operations API 的回應模型。
LroStatus	要求的狀態狀態。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

LongRunningOperationResult

Long-Running Operations API 的回應模型。

名稱	類型	Description
created	string	建立的時間戳。
error	ErrorDetail	錯誤詳細數據。
operationId	string	這個長時間執行作業的標識碼。
status	LroStatus	要求的狀態狀態。
warning	ErrorDetail	錯誤詳細數據。

LroStatus

要求的狀態狀態。

名稱	類型	Description
Failed	string	要求有一或多個失敗。
NotStarted	string	要求尚未開始處理。
Running	string	要求已開始處理。
Succeeded	string	要求已成功完成。

共用方式為

Dataset - Create

提交建立要求

URI 參數

要求標頭

回應

安全性

AADToken

備註

範圍

subscription-key

SAS Token

範例

Create dataset from a converted CAD file provided by conversionId

範例要求

範例回覆

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

其他資源