latest--azure-deviceupdate-manifest-definitions-5.0

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/azure-device-update-for-iot-hub-update-manifest/_shared/latest--azure-deviceupdate-manifest-definitions-5.0.json
Parent schema azure-device-update-for-iot-hub-update-manifest
Type: object

Shared schema definitions for 'Import Manifest' and 'Update Manifest'.

Definitions

updateId object

Unique update identifier.

provider string required

Entity who is creating or directly responsible for the update. It can be a company name.

minLength=1maxLength=64pattern=^[a-zA-Z0-9.-]+$
name string required

Identifier for a class of update. It can be a device class or model name.

minLength=1maxLength=64pattern=^[a-zA-Z0-9.-]+$
version string required

Two to four part dot separated numerical version numbers. Each part must be a number between 0 and 2147483647 and leading zeroes will be dropped.

Examples: "1.0", "2021.11.8"
pattern=^\d+(?:\.\d+)+$
compatibility compatibilityInfo[]

List of device property sets this update is compatible with.

compatibilityInfo Record<string, string>

Properties of a device this update is compatible with.

baseFile object

Update payload file, e.g. binary, firmware, script, etc. Must be unique within update.

filename filename required
sizeInBytes number required

File size in number of bytes.

min=1max=2147483648
hashes fileHashes required
properties object

Optional file properties (not consumed by service but pass-through to device).

file object

Update payload file, e.g. binary, firmware, script, etc. Must be unique within update.

relatedFiles baseFile[]

Optional related files metadata used together with DownloadHandler metadata to download payload file.

minItems=0maxItems=4
downloadHandler object

Download handler for utilizing related files to download payload file.

1 nested properties
id string required

Download handler identifier.

Examples: "microsoft/delta:1"
minLength=5maxLength=32pattern=^\S+/\S+:\d{1,5}$
filename string

Update payload file name.

fileHashes Record<string, string>

Base64-encoded file hashes with algorithm name as key. At least SHA-256 algorithm must be specified, and additional algorithm may be specified if supported by agent.

sha256 string required

Base64-encoded file hash value using SHA-256 algorithm.

fileDownloadHandler object

Download handler for utilizing related files to download payload file.

id string required

Download handler identifier.

Examples: "microsoft/delta:1"
minLength=5maxLength=32pattern=^\S+/\S+:\d{1,5}$
referenceStepType string

Instruction step type that installs another update.

inlineStepType string

Instruction step type that performs code execution.

inlineStepHandler string

Identity of handler on device that can execute this step.

Examples:
  • "microsoft/script:1"
  • "microsoft/swupdate:1"
  • "microsoft/apt:1"
inlineStepHandlerProperties object

JSON object that agent will pass to handler as arguments.