v6

latestSwagger 2.02026-07-135076139.2 KB
Update management

Get a specific update version.

get/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}

Path parameters

instanceIdstring required

The Device Update for IoT Hub account instance identifier.

providerstring required

Update provider.

namestring required

Update name.

versionstring required

Update version.

Query parameters

api-versionstring required

The API version to use for this operation.

Headers

If-None-Matchstring

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

Response

The request has succeeded.

descriptionstring

Update description specified by creator.

friendlyNamestring

Friendly update name specified by importer.

isDeployableboolean

Whether the update can be deployed to a device on its own.

updateTypestring

Update type. Deprecated in latest import manifest schema.

installedCriteriastring

String interpreted by Device Update client to determine if the update is installed on the device. Deprecated in latest import manifest schema.

compatibilityCompatibility[] required

List of update compatibility information.

scanResultstring

Update aggregate scan result (calculated from payload file scan results).

manifestVersionstring required

Schema version of manifest used to import the update.

importedDateTimestring date-time required

Date and time in UTC when the update was imported.

createdDateTimestring date-time required

Date and time in UTC when the update was created.

etagstring

Update ETag.