Device Update - Delete Update
Delete a specific update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.
DELETE https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}?api-version=2022-10-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string url |
The Device Update for IoT Hub account endpoint (hostname only, no protocol). |
|
instance
|
path | True |
string |
The Device Update for IoT Hub account instance identifier. |
|
name
|
path | True |
string |
Update name. |
|
provider
|
path | True |
string |
Update provider. |
|
version
|
path | True |
string |
Update version. |
|
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
Responses
| Name | Type | Description |
|---|---|---|
| 202 Accepted |
Accepted update deletion request; background operation location to track status is specified in Operation-Location response header. Headers Operation-Location: string |
|
| Other Status Codes |
Default response. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| https://api.adu.microsoft.com/.default | Default authorization scope. |
Examples
DeviceUpdate_DeleteUpdate
Sample request
DELETE https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01
Sample response
Operation-Location: /deviceUpdate/blue/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2022-10-01Definitions
| Name | Description |
|---|---|
| Error |
Error details. |
|
Error |
Common error response. |
|
Inner |
An object containing more specific information than the current object about the error. |
Error
Error details.
| Name | Type | Description |
|---|---|---|
| code |
string |
Server defined error code. |
| details |
Error[] |
An array of errors that led to the reported error. |
| innererror |
An object containing more specific information than the current object about the error. |
|
| message |
string |
A human-readable representation of the error. |
| occurredDateTime |
string |
Date and time in UTC when the error occurred. |
| target |
string |
The target of the error. |
ErrorResponse
Common error response.
| Name | Type | Description |
|---|---|---|
| error |
The error details. |
InnerError
An object containing more specific information than the current object about the error.
| Name | Type | Description |
|---|---|---|
| code |
string |
A more specific error code than what was provided by the containing error. |
| errorDetail |
string |
The internal error or exception message. |
| innerError |
An object containing more specific information than the current object about the error. |
|
| message |
string |
A human-readable representation of the error. |