Share via

Updates - Get Update

Service:
Device Update
API Version:
2020-09-01

Get a specific update version.

GET https://{accountEndpoint}/deviceupdate/{instanceId}/v2/updates/providers/{provider}/names/{name}/versions/{version}

URI Parameters

Name In Required Type Description
accountEndpoint
 path True

string

Account endpoint.
instanceId
 path True

string

Account instance identifier.
name
 path True

string

Update name.
provider
 path True

string

Update provider.
version
 path True

string

Update version.

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

Update

The requested update version.
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_GetUpdate

Sample request

GET https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/updates/providers/microsoft/names/adu/versions/1.0.0.0

Sample response

Status code:
200 
{
  "updateId": {
    "provider": "microsoft",
    "name": "adu",
    "version": "1.0.0.0"
  },
  "updateType": "image",
  "installedCriteria": "SwVer=5",
  "compatibility": [
    {
      "deviceManufacturer": "Microsoft",
      "deviceModel": "Toaster"
    }
  ],
  "manifestVersion": "0.1",
  "importedDateTime": "2020-04-22T21:01:43.8408797+00:00",
  "createdDateTime": "2019-09-12T00:00:00.0000000+00:00",
  "etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
}
Status code:
304
Status code:
404
Status code:
429

Definitions

Name Description
Compatibility

Update compatibility information.
Update

Update metadata.
UpdateId

Update identifier.

Compatibility

Object

Update compatibility information.

Name Type Description
deviceManufacturer

string

The manufacturer of device the update is compatible with.
deviceModel

string

The model of device the update is compatible with.

Update

Object

Update metadata.

Name Type Description
compatibility

Compatibility[]

List of update compatibility information.
createdDateTime

string (date-time)

Date and time in UTC when the update was created.
etag

string

Update ETag.
importedDateTime

string (date-time)

Date and time in UTC when the update was imported.
installedCriteria

string

String interpreted by Device Update client to determine if the update is installed on the device.
manifestVersion

string

Schema version of manifest used to import the update.
updateId

UpdateId

Update identity.
updateType

string

Update type.

UpdateId

Object

Update identifier.

Name Type Description
name

string

Update name.
provider

string

Update provider.
version

string

Update version.