Device Update - Delete Update

服務:

Device Update

API 版本:

2022-10-01

刪除特定的更新版本。 這是長時間執行的作業;使用 Operation-Location 回應標頭值來檢查作業狀態。

DELETE https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}?api-version=2022-10-01

URI 參數

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

回應

名稱	類型	Description
202 Accepted		已接受的更新刪除要求;追蹤狀態的背景作業位置是在響應標頭中指定 Operation-Location。 標題 Operation-Location: 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_DeleteUpdate

範例要求

HTTP

DELETE https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01

範例回覆

狀態碼:

202

Operation-Location: /deviceUpdate/blue/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2022-10-01

定義

名稱	Description
Error	錯誤詳細數據。
ErrorResponse	常見的錯誤回應。
InnerError	物件，包含比目前對象有關錯誤的更特定資訊。

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	人類看得懂的錯誤表示法。