image-package
重要
这是 Azure Sphere（旧版）文档。 Azure Sphere（旧版）将于 2027 年 9 月 27 日停用，用户此时必须迁移到 Azure Sphere（集成）。 使用位于 TOC 上方的版本选择器查看 Azure Sphere（集成）文档。
管理磁盘上的 Azure Sphere 映像。
| 操作 | 说明 |
|---|---|
| pack-application | 创建映像包。 |
| pack-board-config | 创建板配置映像包。 |
| show | 显示有关映像包的详细信息。 |
pack-application
从已编译和链接的映像以及 app_manifest.json 文件创建可执行的应用程序。
支持实时的应用程序 (RTApps) 构建为 ELF 或 AXF 文件，而不是原始二进制文件。 在打包 RTApp 之前，请编辑应用程序清单文件，以便将“ApplicationType”设置为“RealTimeCapable”，并将“EntryPoint”设置为 ELF 或 AXF 文件的名称，该文件必须位于应用程序目录的根目录中。
提示
使用 Visual Studio Code 或 Visual Studio 生成 高级应用程序 或 支持实时的应用程序 时，将运行此命令。
- 生成过程创建 approot<应用名称> 目录，该目录是参数中指定的
--package-directory输入目录。 - 应用程序清单文件在参数中
--application-manifest提供。 - 对于高级应用程序，参数中
--target-api-set提供了应用程序运行时版本。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| --目的地 | 映像包的路径 | 指定输出映像包的路径和文件名。 |
| --package-directory | approot_folder的路径 | 标识用作 Azure Sphere 映像文件系统根目录的输入目录。 应用程序的 app_manifest.json 文件必须位于此目录中。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -a、 --application-manifest | 字符串 | 指定应用程序清单文件的路径。 可以是 JSON 文件或包含app_manifest.json的目录。 可以提供相对或绝对路径。 |
| --hardware-definitions | 字符串 | 指定包含硬件定义 （JSON） 文件的目录的路径的可选空格分隔列表。 文件中的值用于将app_manifest.json中的外围名称映射到基础值。 你可以提供相对或绝对路径。 有关详细信息，请参阅硬件定义。 |
| --target-api-set | 字符串 | 指定编译期间使用的目标 API 集的名称。 如果在应用清单中未指定，则需要高级应用。 RTApps 不需要。 |
| --target-definition-filename | 字符串 | 指定用于映射app_manifest.json中的外围设备名称的硬件目标定义文件的名称。 如果应用程序使用硬件定义，则必须提供它。 |
| -x、--executables | executable1，executable2 ... | 指定要在映像包中标记为可执行文件的一个或多个文件的路径。 app_manifest 文件中列出的 EntryPoint 始终标记为可执行文件，因此仅当存在其他可执行文件时才需要 -x 标志。 默认情况下，打包到映像时，文件不是可执行文件。 子路径相对于可执行文件的路径。 路径可以使用 Windows 文件名语法（反斜杠）或 Linux 文件名语法（正斜杠）；不允许使用空格、逗号和分号。 可为每个可执行文件指定 -x，或者只使用此参数一次，并提供多个路径，通过逗号分隔且不插入空格。 |
全局参数
以下全局参数可用于 Azure Sphere CLI：
| 参数 | 说明 |
|---|---|
| --debug | 增加日志记录详细程度以显示所有调试日志。 如果发现了 bug，在提交 bug 报告时，请提供启用 --debug 标志生成的输出。 |
| -h、--help | 打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。 |
| --only-show-errors | 仅显示错误，禁止显示警告。 |
| -o、--output | 更改输出格式。 可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。 默认情况下，CLI 输出 table。 若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。 |
| --query | 使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。 有关详细信息和示例，请参阅 JMESPath 教程 和 查询 Azure CLI 命令输出 。 |
| --verbose | 打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。 使用 --debug 获取完整的调试日志。 |
注意
如果使用 Azure Sphere 经典 CLI，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
azsphere image-package pack-application --package-directory C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --destination myimage.imagepackage
pack-board-config
创建板配置映像包。 可以使用预设的板配置映像，或提供自定义配置映像。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| --目的地 | 字符串 | 为生成的映像包指定输出文件名的路径。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| --board-config-file | 路径 | 标识板配置映像的路径。 如果包含此项， --preset 则不得使用;这两个参数互斥。 |
| -n、--name | 字符串 | 在已创建文件的元数据中设置映像包名称。 如果不提供此项，系统会根据提供的板配置生成新的名称，名称中会使用组件 ID 的一部分以确保唯一性。 |
| -p、--preset | 字符串 | 提供要应用的预设板配置映像的 ID。 输入预设包的 ID，或使用自定义板配置映像的参数提供板配置文件 --board-config-file 的路径。 ID 是枚举值，当前固定为单个值 lan-enc28j60-isu0-int5。 |
全局参数
以下全局参数可用于 Azure Sphere CLI：
| 参数 | 说明 |
|---|---|
| --debug | 增加日志记录详细程度以显示所有调试日志。 如果发现了 bug，在提交 bug 报告时，请提供启用 --debug 标志生成的输出。 |
| -h、--help | 打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。 |
| --only-show-errors | 仅显示错误，禁止显示警告。 |
| -o、--output | 更改输出格式。 可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。 默认情况下，CLI 输出 table。 若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。 |
| --query | 使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。 有关详细信息和示例，请参阅 JMESPath 教程 和 查询 Azure CLI 命令输出 。 |
| --verbose | 打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。 使用 --debug 获取完整的调试日志。 |
注意
如果使用 Azure Sphere 经典 CLI，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
azsphere image-package pack-board-config --preset lan-enc28j60-isu0-int5 --destination board2.imagepackage
显示
显示关于映像包的详细信息。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -f、--image-package | 字符串 | 指定映像包的路径。 你可以提供相对或绝对路径。 |
全局参数
以下全局参数可用于 Azure Sphere CLI：
| 参数 | 说明 |
|---|---|
| --debug | 增加日志记录详细程度以显示所有调试日志。 如果发现了 bug，在提交 bug 报告时，请提供启用 --debug 标志生成的输出。 |
| -h、--help | 打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。 |
| --only-show-errors | 仅显示错误，禁止显示警告。 |
| -o、--output | 更改输出格式。 可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。 默认情况下，CLI 输出 table。 若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。 |
| --query | 使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。 有关详细信息和示例，请参阅 JMESPath 教程 和 查询 Azure CLI 命令输出 。 |
| --verbose | 打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。 使用 --debug 获取完整的调试日志。 |
注意
如果使用 Azure Sphere 经典 CLI，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
azsphere image-package show --image-package C:\sample\quickstart_steps\QuickStart-AzureSphereBlink1\QuickStart-AzureSphereBlink1\out\ARM-Debug\QuickStart-AzureSphereBlink1.imagepackage
Image package metadata:
Section: Identity
Image Type: Application
Component ID: 99d419ef-296d-43b0-ade1-809efe3a7aba
Image ID: d788fdd1-28eb-4477-9818-a4734289f2f1
Section: Signature
Signing Type: ECDsa256
Cert: a8d5cc6958f48710140d7a26160fc1cfc31f5df0
Section: Debug
Image Name: QuickStart-AzureSphereBlink1
Built On (UTC): 09/07/2020 13:18:52
Built On (Local): 09/07/2020 14:18:52
Section: Temporary Image
Remove image at boot: False
Under development: True
Section: ABI Depends
Depends on: ApplicationRuntime, version 5