Azure Device Update for IoT Hub インポート マニフェスト スキーマ

Azure Device Update for IoT Hub に更新プログラムをインポートするときは、更新プログラムに関する重要な情報を定義する、関連付けられた JSON インポート マニフェスト ファイルも送信します。 この記事では、JSON インポート マニフェスト ファイルの作成に使用されるスキーマについて説明します。

インポート マニフェストの概念とファイル構造の詳細については、「 Azure Device Update for IoT Hub インポート マニフェスト」を参照してください。 ファイルの作成方法については、「 Device Update for IoT Hub にインポートする更新プログラムを準備する」を参照してください。

スキーマ

インポートマニフェストの JSON スキーマは SchemaStore.org でホストされ、次のプロパティで構成されています。 その他のプロパティは許可されません。

オブジェクトの更新

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

その他のプロパティは許可されません。

例えば次が挙げられます。

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

互換性オブジェクト

compatibility オブジェクトは、この更新プログラムと互換性があるデバイスの 1 から 5 のプロパティを記述します。 各プロパティは、 string タイプの名前と値のペアです。 名前は 1 から 32 文字、値は 1 から 64 文字の長さにする必要があります。 互換性プロパティのまったく同じセットを、複数の更新プロバイダーと名前の組み合わせで使用することはできません。

例えば次が挙げられます。

{
  "compatibility": [
    {
      "manufacturer": "Contoso",
      "model": "Toaster"
    }
  ]
}

Instructions オブジェクト

instructions オブジェクトには、更新プログラムのインストール手順が表示されます。 instructions オブジェクトには、実行する steps のリストが含まれています。 その他のプロパティは許可されません。

ステップは、実行するコード、または他の更新へのポインターのいずれかです。 ステップ オブジェクトは、type 値が指定されていない場合、デフォルトで inline になります。

例えば次が挙げられます。

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

インラインステップオブジェクト

inlineステップオブジェクトは、コードの実行を実行するインストール指示ステップです。

その他のプロパティは許可されません。

例えば次が挙げられます。

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

参照ステップオブジェクト

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

その他のプロパティは許可されません。

例えば次が挙げられます。

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

Files オブジェクト

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

その他のプロパティは許可されません。

例えば次が挙げられます。

{
  "files": [
    {  
      "fileName": "full-image-file-name",
      "sizeInBytes": 12345,
      "hashes": {...},
      "relatedFiles": [
        {
          "fileName": "delta-from-v1-file-name",
          "sizeInBytes": 1234,
          "hashes": {
            "SHA256": "delta-from-v1-file-hash"
          },
          "properties": {...}
        }  
      ],
      "downloadHandler": {
        "id": "microsoft/delta:1"
        }
    }
  ]
}

Hashes オブジェクト

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

その他のプロパティは許可されます。

例えば次が挙げられます。

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

relatedFiles オブジェクト

relatedFiles オブジェクトには、1 つ以上のプライマリ ペイロード ファイルに関連するファイルのコレクションが含まれています。 詳細については、「 関連ファイル機能を使用して複数の更新ファイルを参照する」を参照してください。

その他のプロパティは許可されます。

例えば次が挙げられます。

"relatedFiles": [
  {
    "filename": "in1_in2_deltaupdate.dat",
    "sizeInBytes": 102910752,
    "hashes": {
      "sha256": "2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="
    },
    "properties": {
      "microsoft.sourceFileHashAlgorithm": "sha256",
      "microsoft.sourceFileHash": "YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="
    }
  }
],

downloadHandler オブジェクト

downloadHandler オブジェクトは、関連ファイルの処理方法を指定します。

その他のプロパティは許可されません。

例えば次が挙げられます。

"downloadHandler": {
  "id": "microsoft/delta:1"
}

関連コンテンツ

• インポートの概念とマニフェスト
• インポートする更新プログラムを準備する
• 更新プログラムをインポートする