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

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

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

スキーマ

追加のプロパティは許可されません。

updateId オブジェクト

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

追加のプロパティは許可されません。

次に例を示します。

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

compatibility オブジェクト

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

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

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

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

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

次に例を示します。

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

instructions オブジェクト

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

追加のプロパティは許可されません。

次に例を示します。

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

inlineStep オブジェクト

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

追加のプロパティは許可されません。

次に例を示します。

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

referenceStep オブジェクト

reference step オブジェクトは、別の更新プログラムをインストールするインストール命令ステップです。

追加のプロパティは許可されません。

次に例を示します。

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

file オブジェクト

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

追加のプロパティは許可されません。

次に例を示します。

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

fileHashes オブジェクト

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

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

次に例を示します。

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

次のステップ

インポートの概念について詳しく説明します。

準備ができたら、インポート プロセスの詳しい手順が示されているインポート攻略ガイドに進んでください。