Device Update - Get Update

Reference

Service:: Device Update

API Version:: 2022-10-01

Get a specific update version.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}?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.
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.

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.
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_GetUpdate

Sample request

HTTP

GET 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

Status code:: 200

{
  "updateId": {
    "provider": "microsoft",
    "name": "adu",
    "version": "1.0.0.0"
  },
  "friendlyName": "Lab Sensor Update v1",
  "description": "Fix for critical vulnerability",
  "compatibility": [
    {
      "deviceManufacturer": "Microsoft",
      "deviceModel": "Toaster"
    }
  ],
  "instructions": {
    "steps": [
      {
        "description": "pre-install script",
        "handler": "microsoft/script:1",
        "handlerProperties": {
          "arguments": "--pre-install"
        },
        "files": [
          "configure.sh"
        ]
      },
      {
        "type": "reference",
        "updateId": {
          "provider": "microsoft",
          "name": "sensor",
          "version": "1.0"
        }
      }
    ]
  },
  "manifestVersion": "5.0",
  "importedDateTime": "2020-04-22T21:01:43.8408797+00:00",
  "createdDateTime": "2019-09-12T00:00:00.0000000+00:00",
  "etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
}

Definitions

Name	Description
Error	Error details.
ErrorResponse	Common error response.
InnerError	An object containing more specific information than the current object about the error.
Instructions
Step	Update install instruction step.
StepType	Step type.
Update	Update metadata.
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.

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.

Instructions

Name	Type	Description
steps	Step[]	Collection of installation steps.

Step

Update install instruction step.

Name	Type	Default value	Description
description	string		Step description.
files	string[]		Collection of file names to be passed to handler during execution. Required if step type is inline.
handler	string		Identity of handler that will execute this step. Required if step type is inline.
handlerProperties	object		Parameters to be passed to handler during execution.
type	StepType	inline	Step type.
updateId	UpdateId		Referenced child update identity. Required if step type is reference.

StepType

Step type.

Name	Type	Description
inline	string
reference	string

Update

Update metadata.

Name	Type	Default value	Description
compatibility	object[]		List of update compatibility information.
createdDateTime	string		Date and time in UTC when the update was created.
description	string		Update description specified by creator.
etag	string		Update ETag.
friendlyName	string		Friendly update name specified by importer.
importedDateTime	string		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. Deprecated in latest import manifest schema.
instructions	Instructions		Update install instructions.
isDeployable	boolean	True	Whether the update can be deployed to a device on its own.
manifestVersion	string		Schema version of manifest used to import the update.
referencedBy	UpdateId[]		List of update identities that reference this update.
scanResult	string		Update aggregate scan result (calculated from payload file scan results).
updateId	UpdateId		Update identity.
updateType	string		Update type. Deprecated in latest import manifest schema.

UpdateId

Update identifier.

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

Share via