Azure Device Update for IoT Hub 导入清单架构

将更新导入 IoT 中心的 Azure 设备更新时，还会提交关联的 JSON 导入清单文件，该文件定义有关更新的重要信息。 本文介绍用于创建 JSON 导入清单文件的架构。

若要了解有关导入清单概念和文件结构的详细信息，请参阅 适用于 IoT 中心导入清单的 Azure 设备更新。 若要了解如何创建文件，请参阅 准备更新以导入 IoT 中心的设备更新。

图式

导入清单 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 对象提供更新安装说明。 指令对象包含要执行的列表 steps 。 不允许使用其他属性。

步骤可以是需要执行的代码，也可以是其他更新的指针。 如果未提供任何值，则步骤对象默认inlinetype为。

例如：

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

Inline step 对象

inline step 对象是完成代码执行的安装说明步骤。

不允许使用其他属性。

例如：

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

Reference step 对象

reference step 对象是安装另一个更新的安装说明步骤。

不允许使用其他属性。

例如：

{
  "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 算法，并且代理支持时可以指定其他算法。 有关如何正确计算哈希的示例，请参阅 Get-AduFileHashesAduUpdate.psm1 脚本中的函数。

允许其他属性。

例如：

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

relatedFiles 对象

该 relatedFiles 对象包含与一个或多个主有效负载文件相关的文件集合。 有关详细信息，请参阅 使用相关文件功能引用多个更新文件。

允许其他属性。

例如：

"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"
}

相关内容

• 导入概念和清单
• 准备好要导入的更新
• 导入更新