Share via

Device Update - Get Operation Status

  • Reference
Service:
Device Update
API Version:
2022-10-01

Retrieve operation status.

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

URI Parameters

Name In Required Type Description
endpoint
 path True

string

url

The Device Update for IoT Hub account endpoint (hostname only, no protocol).
instanceId
 path True

string

The Device Update for IoT Hub account instance identifier.
operationId
 path True

string

Operation identifier.
api-version
 query True

string

Version of the API to be used with the client request.

Request Header

Name Required Type Description
If-None-Match

string

Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.

Responses

Name Type Description
200 OK

UpdateOperation

Operation status.

Headers

Retry-After: string
Other Status Codes

ErrorResponse

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_GetOperationStatus

Sample request

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

Sample response

Status code:
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\""
}

Definitions

Name Description
Error

Error details.
ErrorResponse

Common error response.
InnerError

An object containing more specific information than the current object about the error.
OperationStatus

Operation status.
UpdateId

Update identifier.
UpdateInfo

Update information.
UpdateOperation

Operation metadata.

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

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

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

InnerError

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.

OperationStatus

Operation status.

Name Type Description
Failed

string

Background operation finished with failure.
NotStarted

string

Background operation created but not started yet.
Running

string

Background operation is currently running.
Succeeded

string

Background operation finished with success.

UpdateId

Update identifier.

Name Type Description
name

string

Update name.
provider

string

Update provider.
version

string

Update version.

UpdateInfo

Update information.

Name Type Description
description

string

Update description.
friendlyName

string

Friendly update name.
updateId

UpdateId

Update identifier.

UpdateOperation

Operation metadata.

Name Type Description
createdDateTime

string

Date and time in UTC when the operation was created.
error

Error

Operation error encountered, if any.
etag

string

Operation ETag.
lastActionDateTime

string

Date and time in UTC when the operation status was last updated.
operationId

string

Operation Id.
resourceLocation

string

Location of the imported update when operation is successful.
status

OperationStatus

Operation status.
traceId

string

Operation correlation identity that can used by Microsoft Support for troubleshooting.
update

UpdateInfo

The update being imported or deleted. For import, this property will only be populated after import manifest is processed successfully.