Updates - Get Operation
擷取作業狀態。
GET https://{accountEndpoint}/deviceupdate/{instanceId}/v2/updates/operations/{operationId}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
account
|
path | True |
string |
帳戶端點。 |
instance
|
path | True |
string |
帳戶實例標識碼。 |
operation
|
path | True |
string |
操作識別碼。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
If-None-Match |
string |
定義 If-None-Match 條件。 只有在伺服器上的 ETag 不符合此值時,才會執行作業。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
作業狀態。 標題 Retry-After: string |
|
404 Not Found |
找不到。 |
|
429 Too Many Requests |
太多要求;在一段時間內可以執行的作業數目有速率限制。 |
|
Other Status Codes |
未修改。 |
安全性
azure_auth_implicit
Azure Active Directory OAuth2 隱含流程
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
azure_auth_code
Azure Active Directory OAuth2 AccessCode Flow
類型:
oauth2
Flow:
accessCode
授權 URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
權杖 URL:
https://login.microsoftonline.com/common/oauth2/v2.0/token
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
azure_auth_application
Azure Active Directory OAuth2 應用程式流程
類型:
oauth2
Flow:
application
權杖 URL:
https://login.microsoftonline.com/common/oauth2/v2.0/token
範圍
名稱 | Description |
---|---|
.default | 用戶端認證範圍 |
azure_auth_password
Azure Active Directory OAuth2 密碼流程
類型:
oauth2
Flow:
password
權杖 URL:
https://login.microsoftonline.com/common/oauth2/v2.0/token
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
Updates_GetOperation
範例要求
GET https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f
範例回覆
{
"operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
"status": "Succeeded",
"resourceLocation": "/v2/updates/providers/microsoft/names/adu/versions/1.0.0.0",
"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 |
錯誤詳細數據。 |
Inner |
物件,包含比目前對象有關錯誤的更特定資訊。 |
Operation |
作業元數據。 |
Operation |
作業狀態。 |
Update |
更新標識碼。 |
Error
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
code |
string |
伺服器定義的錯誤碼。 |
details |
Error[] |
導致回報錯誤的錯誤陣列。 |
innererror |
物件,包含比目前對象有關錯誤的更特定資訊。 |
|
message |
string |
人類看得懂的錯誤表示法。 |
occurredDateTime |
string |
發生錯誤的 UTC 日期和時間。 |
target |
string |
錯誤的目標。 |
InnerError
物件,包含比目前對象有關錯誤的更特定資訊。
名稱 | 類型 | Description |
---|---|---|
code |
string |
比包含錯誤所提供的錯誤碼更具體。 |
errorDetail |
string |
內部錯誤或例外狀況訊息。 |
innerError |
物件,包含比目前對象有關錯誤的更特定資訊。 |
|
message |
string |
人類看得懂的錯誤表示法。 |
Operation
作業元數據。
名稱 | 類型 | Description |
---|---|---|
createdDateTime |
string |
建立作業的 UTC 日期和時間。 |
error |
發生作業錯誤,如果有的話。 |
|
etag |
string |
作業 ETag。 |
lastActionDateTime |
string |
上次更新作業狀態的 UTC 日期和時間。 |
operationId |
string |
作業識別碼。 |
resourceLocation |
string |
作業成功時匯入更新的位置。 |
status |
作業狀態。 |
|
traceId |
string |
Microsoft 支援服務 可用來進行疑難解答的作業相互關聯識別。 |
updateId |
正在匯入或刪除之更新的身分識別。 針對匯入,只有在成功處理匯入指令清單之後,才會填入此屬性。 |
OperationStatus
作業狀態。
名稱 | 類型 | Description |
---|---|---|
Failed |
string |
背景作業已完成失敗。 |
NotStarted |
string |
已建立背景作業,但尚未啟動。 |
Running |
string |
背景作業目前正在執行。 |
Succeeded |
string |
背景作業已順利完成。 |
Undefined |
string |
未定義的作業狀態。 |
UpdateId
更新標識碼。
名稱 | 類型 | Description |
---|---|---|
name |
string |
更新名稱。 |
provider |
string |
更新提供者。 |
version |
string |
更新版本。 |