image
重要
这是 Azure Sphere（旧版）文档。 Azure Sphere（旧版）将于 2027 年 9 月 27 日停用，用户此时必须迁移到 Azure Sphere（集成）。 使用位于 TOC 上方的版本选择器查看 Azure Sphere（集成）文档。
管理磁盘上的 Azure Sphere 映像。
| 操作 | 说明 |
|---|---|
| add | 上载新映像。 |
| 下载 | 下载映像。 |
| show | 显示有关指定映像的信息。 |
add
将新映像上传到 Azure Sphere 租户。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| --图像 | 字符串 | 指定要上传的图像的路径。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -t、--tenant | GUID 或名称 | 指定要在其中执行此操作的租户。 替代默认选定的租户。 可以指定租户 ID 或租户名称。 |
| --临时 | 布尔 | 将映像包标记为临时。 此参数适合在生产过程中使用。 |
| --force | 布尔 | 强制使用 Beta API 上传图像。 |
| -r、--regional-data-boundary | 字符串 | 此图像的区域数据边界。 允许的值：EU、None。 默认值为 None。 如果未指定任何值，将使用默认值。 有关详细信息，请参阅 配置故障转储 - Pivacy 注意事项 |
全局参数
以下全局参数可用于 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 add --image C:\sample\quickstart_steps\QuickStart-AzureSphereBlink1\QuickStart-AzureSphereBlink1\out\ARM-Debug\QuickStart-AzureSphereBlink1.imagepackage --temporary
Uploading image from file 'C:\sample\quickstart_steps\QuickStart-AzureSphereBlink1\QuickStart-AzureSphereBlink1\out\ARM-Debug\QuickStart-AzureSphereBlink1.imagepackage':
--> Image ID: d788fdd1-28eb-4477-9818-a4734289f2f1
--> Component ID: 99d419ef-296d-43b0-ade1-809efe3a7aba
--> Component name: 'QuickStart-AzureSphereBlink1'
Retaining temporary state for uploaded image.
Successfully uploaded image with ID 'd788fdd1-28eb-4477-9818-a4734289f2f1' and name 'QuickStart-AzureSphereBlink1' to component with ID '99d419ef-296d-43b0-ade1-809efe3a7aba'.
下载
从 Azure Sphere 租户下载现有映像。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -i、--image | 字符串 | 指定要下载的映像的 ID。 运行 azsphere image add 命令以获取映像 ID。 |
| --目的地 | 字符串 | 指定存储映像的路径和文件名。 文件路径可以是绝对路径或相对路径。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -t、--tenant | GUID 或名称 | 指定要在其中执行此操作的租户。 替代默认选定的租户。 可以指定租户 ID 或租户名称。 |
全局参数
以下全局参数可用于 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 download --image d788fdd1-28eb-4477-9818-a4734289f2f1 --destination AzureSphereBlink1.image
Getting the image with ID 'd788fdd1-28eb-4477-9818-a4734289f2f1'.
---------
Result
=========
Succeeded
---------
显示
显示 Azure Sphere 租户中现有映像的详细信息。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -i、--image | GUID | 指定要获取其详细信息的图像的 ID。 运行 azsphere image add 命令以获取映像 ID。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -t、--tenant | GUID 或名称 | 指定要在其中执行此操作的租户。 替代默认选定的租户。 可以指定租户 ID 或租户名称。 |
全局参数
以下全局参数可用于 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 show --image d788fdd1-28eb-4477-9818-a4734289f2f1
------------------------------------ ------------------------------------ ---------------------------- ------------- ------------ ---------------------
ImageId ComponentId Name SigningStatus ImageType RegionalDataBoundary
========================================================================================================================================================
d788fdd1-28eb-4477-9818-a4734289f2f1 99d419ef-296d-43b0-ade1-809efe3a7aba QuickStart-AzureSphereBlink1 Succeeded Applications None
------------------------------------ ------------------------------------ ---------------------------- ------------- ------------ ---------------------