Device Update - Get Operation Status

服務:

Device Update

API 版本:

2022-10-01

擷取作業狀態。

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/operations/{operationId}?api-version=2022-10-01

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string url	IoT 中樞 帳戶端點的裝置更新 (主機名，沒有通訊協定) 。
instanceId	path	True	string	IoT 中樞 帳戶實例標識碼的裝置更新。
operationId	path	True	string	操作識別碼。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

要求標頭

名稱	必要	類型	Description
If-None-Match		string	定義 If-None-Match 條件。 只有在伺服器上的 ETag 不符合此值時，才會執行作業。

回應

名稱	類型	Description
200 OK	UpdateOperation	作業狀態。 標題 Retry-After: string
Other Status Codes	ErrorResponse	默認回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://api.adu.microsoft.com/.default	默認授權範圍。

範例

DeviceUpdate_GetOperationStatus

範例要求

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2022-10-01

範例回覆

狀態碼:

200

{
  "operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
  "status": "Succeeded",
  "update": {
    "updateId": {
      "provider": "microsoft",
      "name": "adu",
      "version": "1.0.0.0"
    },
    "friendlyName": "Microsoft ADU v1"
  },
  "resourceLocation": "/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01",
  "traceId": "2b881ef9deaf5d45b0a716ca5b4145ec",
  "createdDateTime": "2020-04-22T21:00:53.2548897+00:00",
  "lastActionDateTime": "2020-04-22T21:01:43.9401420+00:00",
  "etag": "\"a0f7b6f2-3f6c-4eb6-8a59-2f5411c23888\""
}

定義

名稱	Description
Error	錯誤詳細數據。
ErrorResponse	常見的錯誤回應。
InnerError	物件，包含比目前對象有關錯誤的更特定資訊。
OperationStatus	作業狀態。
UpdateId	更新標識碼。
UpdateInfo	更新資訊。
UpdateOperation	作業元數據。

Error

錯誤詳細數據。

名稱	類型	Description
code	string	伺服器定義的錯誤碼。
details	Error[]	導致回報錯誤的錯誤陣列。
innererror	InnerError	物件，包含比目前對象有關錯誤的更特定資訊。
message	string	人類看得懂的錯誤表示法。
occurredDateTime	string	發生錯誤的 UTC 日期和時間。
target	string	錯誤的目標。

ErrorResponse

常見的錯誤回應。

名稱	類型	Description
error	Error	錯誤詳細資料。

InnerError

物件，包含比目前對象有關錯誤的更特定資訊。

名稱	類型	Description
code	string	比包含錯誤所提供的錯誤碼更具體。
errorDetail	string	內部錯誤或例外狀況訊息。
innerError	InnerError	物件，包含比目前對象有關錯誤的更特定資訊。
message	string	人類看得懂的錯誤表示法。

OperationStatus

作業狀態。

名稱	類型	Description
Failed	string	背景作業已完成失敗。
NotStarted	string	已建立背景作業，但尚未啟動。
Running	string	背景作業目前正在執行。
Succeeded	string	背景作業已順利完成。

UpdateId

更新標識碼。

名稱	類型	Description
name	string	更新名稱。
provider	string	更新提供者。
version	string	更新版本。

UpdateInfo

更新資訊。

名稱	類型	Description
description	string	更新描述。
friendlyName	string	易記的更新名稱。
updateId	UpdateId	更新標識碼。

UpdateOperation

作業元數據。

名稱	類型	Description
createdDateTime	string	建立作業的 UTC 日期和時間。
error	Error	發生作業錯誤，如果有的話。
etag	string	作業 ETag。
lastActionDateTime	string	上次更新作業狀態的 UTC 日期和時間。
operationId	string	作業識別碼。
resourceLocation	string	作業成功時匯入更新的位置。
status	OperationStatus	作業狀態。
traceId	string	可供 Microsoft 支援服務 用於疑難解答的作業相互關聯身分識別。
update	UpdateInfo	正在匯入或刪除的更新。 針對匯入，只有在成功處理匯入指令清單之後，才會填入此屬性。