Device Update for IoT Hub への更新プログラムのインポート: スキーマとその他の情報

IoT Hub 用の Device Update に更新プログラムをインポートしたい場合は、まず 概念 を確認し、ハウツーガイド と をレビューしてください。 インポート マニフェスト スキーマの詳細、または API のアクセス許可に関する情報に関心がある場合は、以下を参照してください。

インポート マニフェスト JSON スキーマは、 SchemaStore.org でホストされます。

スキーマ

追加のプロパティは使用できません。

updateId オブジェクト

updateID オブジェクトは、更新ごとに一意の識別子です。

追加のプロパティは使用できません。

次に例を示します。

{
  "updateId": {
    "provider": "Contoso",
    "name": "Toaster",
    "version": "1.0"
  }
}

互換性オブジェクト

互換性オブジェクトは、この更新プログラムと互換性のあるデバイスのプロパティを記述します。

• 型: object
• 最小プロパティ: 1
• 最大プロパティ: 5

各プロパティは、文字列型の名前と値のペアです。

• プロパティ名の最小長: 1
• プロパティ名の最大長: 32
• プロパティ値の最小長: 1
• プロパティ値の最大長: 64

同じ互換性プロパティのセットを、複数の更新プロバイダーと名前の組み合わせで使用することはできません。

次に例を示します。

{
  "compatibility": [
    {
      "deviceManufacturer": "Contoso",
      "deviceModel": "Toaster"
    }
  ]
}

説明オブジェクト

instructions オブジェクトは、更新プログラムのインストール手順を提供します。 instructions オブジェクトには、実行するステップの一覧が含まれています。 ステップには、実行するコードまたは別の更新プログラムへのポインターを指定できます。

追加のプロパティは使用できません。

次に例を示します。

{
  "instructions": {
    "steps": [
      {
        "type": "inline",
        ...
      },
      {
        "type": "reference",
        ...
      }
    ]
  }
}

inlineStep オブジェクト

インライン ステップ オブジェクトは、コード実行を実行するインストール命令ステップです。

追加のプロパティは使用できません。

次に例を示します。

{
  "steps": [
    {
      "description": "pre-install script",
      "handler": "microsoft/script:1",
      "handlerProperties": {
        "arguments": "--pre-install"
      },
      "files": [
        "configure.sh"
      ]
    }
  ]
}

referenceStep オブジェクト

参照ステップオブジェクト は、別の更新プログラムをインストールするためのインストール指示ステップです。

追加のプロパティは使用できません。

次に例を示します。

{
  "steps": [
    {
      "type": "reference",
      "updateId": {
        "provider": "Contoso",
        "name": "Toaster.HeatingElement",
        "version": "1.0"
      }
    }
  ]
}

ファイルオブジェクト

オブジェクト ファイルは、バイナリ、ファームウェア、スクリプトなどの更新ペイロード ファイルです。各ファイル オブジェクトは、更新プログラム内で一意である必要があります。

追加のプロパティは使用できません。

次に例を示します。

{
  "files": [
    {
      "filename": "configure.sh",
      "sizeInBytes": 7558,
      "hashes": {...}
    }
  ]
}

fileHashes オブジェクト

Base64 でエンコードされたファイル ハッシュ。アルゴリズム名をキーとして使用します。 少なくとも SHA-256 アルゴリズムを指定する必要があり、エージェントでサポートされている場合は他のアルゴリズムを指定できます。 ハッシュを正しく計算する方法の例については、 AduUpdate.psm1 スクリプトの Get-AduFileHashes 関数を参照してください。

追加のプロパティを使用できます。

次に例を示します。

{
  "hashes": {
    "sha256": "/CD7Sn6fiknWa3NgcFjGlJ+ccA81s1QAXX4oo5GHiFA="
  }
}

次のステップ

インポートの概念の詳細を確認します。

準備ができたら、 インポート How-To ガイドを試してみてください。このガイドでは、インポート プロセスの手順を順を追って説明します。