Azure Device Update for IoT Hub import manifest

5.0

Schema URL

https://catalog.lintel.tools/schemas/schemastore/azure-device-update-for-iot-hub-import-manifest/versions/5.0.json
← Back to Azure Device Update for IoT Hub import manifest
Type: object

Schema for import manifest used for importing an update to Device Update for IoT Hub.

Properties

updateId updateId required
compatibility compatibility required
instructions object required

Update installation instructions.

1 nested properties
steps inlineStep | referenceStep[] required
minItems=1maxItems=10
manifestVersion string required

Import manifest schema version. Must be 5.0.

Constant: "5.0"
createdDateTime string required

Date & time import manifest was created in ISO 8601 format.

Examples: "2020-10-02T22:18:04.9446744Z"
$schema string

JSON schema reference.

description string

Optional update description.

minLength=1maxLength=512
files file[]

List of update payload files. Sum of all file sizes may not exceed 2 GB. May be empty or null if all instruction steps are reference steps.

minItems=0maxItems=10

Definitions

instructions object

Update installation instructions.

steps inlineStep | referenceStep[] required
minItems=1maxItems=10
stepDescription string

Optional instruction step description.

inlineStep object

Installation instruction step that performs code execution.

handler inlineStepHandler required
files filename[] required

Names of update files that agent will pass to handler.

minItems=1maxItems=10
type inlineStepType
description string

Optional instruction step description.

minLength=1maxLength=64
handlerProperties inlineStepHandlerProperties
referenceStep object

Installation instruction step that installs another update.

type referenceStepType required
updateId updateId required
description string

Optional instruction step description.

minLength=1maxLength=64

Examples

{
  "updateId": {
    "provider": "Microsoft",
    "name": "Toaster",
    "version": "1.0"
  },
  "description": "Example update",
  "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"
        }
      }
    ]
  },
  "files": [
    {
      "filename": "configure.sh",
      "sizeInBytes": 718,
      "hashes": {
        "sha256": "mcB5SexMU4JOOzqmlJqKbue9qMskWY3EI/iVjJxCtAs="
      },
      "relatedFiles": [
        {
          "filename": "in1_in2_deltaupdate.dat",
          "sizeInBytes": 102910752,
          "hashes": {
            "sha256": "2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="
          },
          "properties": {
            "microsoft.sourceFileHashAlgorithm": "sha256",
            "microsoft.sourceFileHash": "YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="
          }
        }
      ],
      "downloadHandler": {
        "id": "microsoft/delta:1"
      }
    }
  ],
  "manifestVersion": "5.0",
  "createdDateTime": "2020-10-02T22:18:04.9446744Z"
}