Updates - Get Operation

Service:

Device Update

API Version:

2020-09-01

Retrieve operation status.

GET https://{accountEndpoint}/deviceupdate/{instanceId}/v2/updates/operations/{operationId}

URI Parameters

Name	In	Required	Type	Description
accountEndpoint	path	True	string	Account endpoint.
instanceId	path	True	string	Account instance identifier.
operationId	path	True	string	Operation identifier.

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	Operation	Operation status. Headers Retry-After: string
404 Not Found		Not found.
429 Too Many Requests		Too many requests; there is a rate limit on how many operations can be executed within a time period.
Other Status Codes		Not modified.

Security

azure_auth_implicit

Azure Active Directory OAuth2 Implicit Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

azure_auth_code

Azure Active Directory OAuth2 AccessCode Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Scopes

Name	Description
user_impersonation	impersonate your user account

azure_auth_application

Azure Active Directory OAuth2 Application Flow

Type: oauth2
Flow: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Scopes

Name	Description
.default	client credential scope

azure_auth_password

Azure Active Directory OAuth2 Password Flow

Type: oauth2
Flow: password
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Updates_GetOperation

Sample Request

HTTP

GET https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f

Sample Response

Status code:

200

{
  "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\""
}

Status code:

304

Status code:

404

Status code:

429

Definitions

Name	Description
Error	Error details.
InnerError	An object containing more specific information than the current object about the error.
Operation	Operation metadata.
OperationStatus	Operation status.
UpdateId	Update identifier.

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.

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.

Operation

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.
updateId	UpdateId	The identity of update being imported or deleted. For import, this property will only be populated after import manifest is processed successfully.

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.
Undefined	string	Undefined operation status.

UpdateId

Update identifier.

Name	Type	Description
name	string	Update name.
provider	string	Update provider.
version	string	Update version.