Dataset - Get Operation

Service:

Maps Creator

API Version:

2023-03-01-preview

用來檢查數據集建立程序的狀態。

提交作業要求

若要檢視數據集作業的目前進度，您將使用 GET 要求，其中 operationId 指定的路徑是代表作業的標識碼。

作業回應

進行中時， 200-OK 不會傳回 HTTP 狀態代碼，而且沒有額外的標頭。 如果作業成功， 200-OK 則會傳回具有 Resource-Location 標頭的 HTTP 狀態代碼。

GET https://{geography}.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview

URI 參數

名稱	位於	必要	類型	Description
geography	path	True	string	此參數會指定 Azure 地圖服務 Creator 資源所在的位置。 有效值為us和 eu。
operationId	path	True	string	查詢數據集建立/匯入要求狀態的標識符。
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	LongRunningOperationResult	作業正在執行或完成。 如果作業成功，請使用 Resource-Location 標頭來取得結果的路徑。 Headers Resource-Location: string
Other Status Codes	ErrorResponse	發生意外錯誤。

安全性

AADToken

這些是 Azure Active Directory OAuth2 流程。 與 Azure 角色型存取控制配對時，可用來控制對 #D0509AE539ABE4A3FAC469DEC7ABF2211 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務 資源帳戶或子資源的存取權。 任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權，以 Azure 地圖服務 REST API。

若要實作案例，建議您檢視 驗證概念。 總而言之，此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件，提供將應用程式模型化 () 的解決方案。

備註

• 此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務 資源。 這可以從 地圖管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。 主權雲端具有唯一的授權 URL 和 Azure Active Directory 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式設定。

• 目前，Azure Active Directory v1.0 或 v2.0 支援公司、學校和來賓，但不支持個人帳戶。

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 中建立 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

範例

Get the status of an operation which has finished successfully

Get the status of an operation which is still running

Get the status of an operation which has finished successfully

Sample Request

HTTP

GET https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview

Sample Response

Status code:

200

Resource-Location: https://us.atlas.microsoft.com/datasets/{datasetId}?api-version=2023-03-01-preview

Response Body

{
  "operationId": "{operationId}",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Get the status of an operation which is still running

Sample Request

HTTP

GET https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview

Sample Response

Status code:

200

{
  "operationId": "{operationId}",
  "created": "2021-04-23T19:14:03.2452596+00:00",
  "status": "Running"
}

定義

名稱	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	要求已成功完成。