product
重要
这是 Azure Sphere（旧版）文档。 Azure Sphere（旧版）将于 2027 年 9 月 27 日停用，用户此时必须迁移到 Azure Sphere（集成）。 使用位于 TOC 上方的版本选择器查看 Azure Sphere（集成）文档。
管理产品。
| 操作 | 说明 |
|---|---|
| create | 创建新产品。 |
| delete | 删除现有产品。 |
| device | 显示此产品中的设备。 |
| device-group | 管理产品设备组。 |
| list | 列出 Azure Sphere 租户中的所有产品。 |
| show | 显示有关产品的详细信息。 |
| update | 更新指定的元数据。 |
create
创建新产品。
azsphere product create 命令自动将五个默认设备组添加到创建的产品：
- “开发”设备组会禁用云应用程序更新并提供零售版 OS。
- 现场测试 设备组启用云应用程序更新并交付零售 OS。
- 生产 设备组启用云应用程序更新并交付零售 OS。
- “生产 OS 评估”设备组会启用云应用程序更新并提供零售评估版 OS。
- “现场测试 OS 评估”设备组会启用云应用程序更新并提供零售评估版 OS。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -n、--name | 字符串 | 指定产品的名称。 该名称只能包含字母数字字符。 如果名称包含空格，请将其用引号括起来。 产品名称不能超过 50 个字符，不区分大小写，并且必须在租户中是唯一的。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -g、--no-default-device-groups | 布尔 | 指定可阻止创建默认设备组的可选标志。 |
| -t、--tenant | GUID 或名称 | 指定要在其中执行此操作的租户。 替代默认选定的租户。 可以指定租户 ID 或租户名称。 |
| -d、--description | 字符串 | 指定要描述产品的可选文本。 最大长度为 100 个字符。 如果描述包含空格，则请将其括在引号中。 |
全局参数
以下全局参数可用于 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 product create --name DW100 --description "Contoso DW100 models"
Default device groups will been created for this product, use the 'azsphere product device-group list' command to see them.
------------------------------------ -------------------- ----- ------------------------------------
TenantId Description Name Id
====================================================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb Contoso DW100 models DW100 6f52bead-700d-4289-bdc2-2f11f774270e
------------------------------------ -------------------- ----- ------------------------------------
delete
删除 Azure Sphere 租户中的指定产品。
只有在以下情况下才能删除产品：
- 用户对租户具有管理员权限。
- 产品为空，设备组中没有设备。 azsphere product device list 命令列出产品中的所有设备。 运行 azsphere device update --device-group 将设备移动到其他设备组或 azsphere device-group delete 以删除设备组。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -p、--product | GUID 或名称 | 指定要删除的产品。 可以指定 Azure Sphere 产品的 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，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
按 ID 指定产品的示例：
azsphere product delete --product 6f52bead-700d-4289-bdc2-2f11f774270e
按名称指定产品的示例：
azsphere product delete --product DW100
应看到如下输出：
Successfully deleted the product
device
显示产品内的设备。
| 操作 | 说明 |
|---|---|
| list | 显示指定产品内的设备。 |
| show-count | 返回产品内的设备数。 |
device list
显示指定产品内的设备，按设备 ID 列出。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -p、--product | GUID 或名称 | 指定要在其中列出设备的产品。 可以指定 Azure Sphere 产品的 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，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
按 ID 指定产品的示例：
azsphere product device list --product 6f52bead-700d-4289-bdc2-2f11f774270e
按名称指定产品的示例：
azsphere product device list --product DW100
应看到如下输出：
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ------------------------------------
DeviceId TenantId ProductId DeviceGroupId
===============================================================================================================================================================================================================================================
352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 143adbc9-1bf0-4be2-84a2-084a331d81cb 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ------------------------------------
device show-count
返回产品内所有设备组中所有设备的总数。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -p、--product | GUID 或名称 | 指定显示目标设备数的产品。 可以指定 Azure Sphere 产品的 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，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
按 ID 指定产品的示例：
azsphere product device show-count --product 6f52bead-700d-4289-bdc2-2f11f774270e
按名称指定产品的示例：
azsphere product device show-count --product DW100
应看到如下输出：
------
Result
======
2
------
device-group
管理产品设备组。
| 操作 | 说明 |
|---|---|
| create-defaults | 在指定的产品中创建默认设备组。 |
| list | 显示指定产品内的设备组。 |
device-group create-defaults
在现有产品中创建默认设备组。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -p、--product | GUID 或名称 | 指定要获取的产品。 可以指定 Azure Sphere 产品的 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，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
按 ID 指定产品的示例：
azsphere product device-group create-defaults --product 6f52bead-700d-4289-bdc2-2f11f774270e
按名称指定产品的示例：
azsphere product device-group create-defaults --product DW100
应看到如下输出：
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- -------------------------
Id Name Description ProductId OsFeedType UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
=====================================================================================================================================================================================================================================================================================
6406868c-19bb-4bea-b4cf-fd80608ee5cb Development Default development device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 Retail Accept only system software updates. Don't accept application updates. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
d2e2b2e7-e219-4af8-8876-f8d10624778b Field Test Default test device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 Retail Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
822f1bda-32d7-404a-bf37-9f90aad09509 Production Default production device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 Retail Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
3fafc0e1-f336-4a8a-9be4-fb275322d2cc Production OS Evaluation Default Production OS Evaluation device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 RetailEval Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
b9b7f388-2ad4-4a7e-a4dc-6559fb80741d Field Test OS Evaluation Default Field Test OS Evaluation device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 RetailEval Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
device-group list
列出产品中的所有设备组。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -p、--product | GUID 或名称 | 指定要列出其设备组的产品。 可以指定 Azure Sphere 产品的 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，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
按 ID 指定产品的示例：
azsphere product device-group list --product 6f52bead-700d-4289-bdc2-2f11f774270e
按名称指定产品的示例：
azsphere product device-group list --product DW100
应看到如下输出：
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- -------------------------
Id TenantId OsFeedType ProductId Name Description UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
==========================================================================================================================================================================================================================================================================================================================
6406868c-19bb-4bea-b4cf-fd80608ee5cb 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 4f48d618-09f7-45dc-a5a4-1433cabbee91 Development Default development device group Accept only system software updates. Don't accept application updates. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
d2e2b2e7-e219-4af8-8876-f8d10624778b 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 4f48d618-09f7-45dc-a5a4-1433cabbee91 Field Test Default test device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
822f1bda-32d7-404a-bf37-9f90aad09509 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 4f48d618-09f7-45dc-a5a4-1433cabbee91 Production Default production device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
a6c64cda-4ff0-48bb-8a30-6ffab322b846 143adbc9-1bf0-4be2-84a2-084a331d81cb RetailEval 4f48d618-09f7-45dc-a5a4-1433cabbee91 Production OS Evaluation Default Production OS Evaluation device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
3fafc0e1-f336-4a8a-9be4-fb275322d2cc 143adbc9-1bf0-4be2-84a2-084a331d81cb RetailEval 4f48d618-09f7-45dc-a5a4-1433cabbee91 Field Test OS Evaluation Default Field Test OS Evaluation device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
b9b7f388-2ad4-4a7e-a4dc-6559fb80741d 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 4f48d618-09f7-45dc-a5a4-1433cabbee91 Marketing Default Marketing device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
列表
列出 Azure Sphere 租户中的所有产品。
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -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 product list
------------------------------------ ------------------------------------ --------- --------------------
Id TenantId Name Description
========================================================================================================
6f52bead-700d-4289-bdc2-2f11f774270e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW100 Contoso DW100 models
------------------------------------ ------------------------------------ --------- --------------------
6a82518f-8965-4bd6-ba79-43aa3fcafe5e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW200 Contoso DW200 models
------------------------------------ ------------------------------------ --------- --------------------
显示
显示有关产品的详细信息。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -p、--product | GUID 或名称 | 指定要获取的产品。 可以指定 Azure Sphere 产品的 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，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
按 ID 指定产品和租户的示例：
azsphere product show --product 6f52bead-700d-4289-bdc2-2f11f774270e --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
按名称指定产品和租户的示例：
azsphere product show --product DW100 --tenant MyTenant
应看到如下输出：
------------------------------------ ------------------------------------ ----- --------------------
Id TenantId Name Description
====================================================================================================
6f52bead-700d-4289-bdc2-2f11f774270e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW100 Contoso DW100 models
------------------------------------ ------------------------------------ ----- --------------------
update
更新指定的产品元数据。
必须至少提供一个可选参数，或者--newname--newdescription提供 。 可以在单个命令中指定两者。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -p、--product | GUID 或名称 | 指定要更新的产品。 可以指定 Azure Sphere 产品的 ID 或名称。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -n、--new-name | 字符串 | 指定产品的新名称。 该名称只能包含字母数字字符。 如果名称包含空格，请将其用引号括起来。 产品名称不能超过 50 个字符，不区分大小写，并且必须在租户中是唯一的。 |
| -d、--new-description | 字符串 | 指定要描述产品的可选文本。 最大长度为 100 个字符。 |
| -t、--tenant | 字符串 | 指定要在其中执行此操作的租户。 替代默认选定的租户。 可以指定租户 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，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
按 ID 指定产品的示例：
azsphere product update --product 6f52bead-700d-4289-bdc2-2f11f774270e --new-description Contoso DW100 models
按名称指定产品的示例：
azsphere product update --product DW100 --new-description Contoso DW100 models
应看到如下输出：
------------------------------------ ------------------------------------ ----- ------------------
Id TenantId Name Description
==================================================================================================
6a82518f-8965-4bd6-ba79-43aa3fcafe5e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW200 Contoso DW200 models
------------------------------------ ------------------------------------ ----- ------------------