device-group
重要
这是 Azure Sphere（旧版）文档。 Azure Sphere（旧版）将于 2027 年 9 月 27 日停用，用户此时必须迁移到 Azure Sphere（集成）。 使用位于 TOC 上方的版本选择器查看 Azure Sphere（集成）文档。
创建和管理设备组。
设备组按标识符 (ID) 或产品名称和设备组名称对进行处理。
| 操作 | 说明 |
|---|---|
| create | 创建新的设备组。 |
| list | 列出 Azure Sphere 租户中的所有设备组。 |
| delete | 删除现有设备组。 |
| 部署 | 管理设备组中的部署。 |
| device | 列出设备组中的设备。 |
| show | 显示有关设备组的信息。 |
| update | 修改现有设备组。 |
create
为指定的产品创建具有指定名称的设备组。 设备组对具有相同产品且从云接收相同应用程序的设备进行组织。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -p、--product | GUID 或名称 | 指定要将此设备组添加到的产品。 可以指定 Azure Sphere 产品的 ID 或名称。 |
| -n、--name | 字符串 | 指定设备组的名称。 该名称只能包含字母数字字符。 如果名称包含空格，请将其用引号括起来。 设备组名称不能超过 50 个字符（不区分大小写）必须在产品中是唯一的。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -a、 --application-update | Enum | 指定要应用于此设备组的应用程序更新策略。 接受的值： No3rdPartyAppUpdates、 UpdateAll和 NoUpdates。 默认值为 UpdateAll。 策略 NoUpdates 当前仅保留供内部使用。 |
| -f、--os-feed | Enum | 指定要用于 OS 更新的 OS 源类型。 接受的值：Retail、RetailEval。 |
| -t、--tenant | GUID 或名称 | 指定要在其中执行此操作的租户。 替代默认选定的租户。 可以指定租户 ID 或租户名称。 |
| -d、--description | 字符串 | 指定要描述设备组的可选文本。 最大长度为 100 个字符。 如果描述包含空格，则请将其括在引号中。 |
| -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 device-group create --name Marketing --product DW100
------------------------------------ ------------------------------------ ---------- ------------------------------------ ---------- ---------------------------------------------------------- ----------------------------- ---------------------
Id TenantId OsFeedType ProductId Name UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
===================================================================================================================================================================================================================================================
7f860cc1-4949-4000-a541-9a988ba4c3cd 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 6f52bead-700d-4289-bdc2-2f11f774270e Marketing 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 device-group list --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- ---------------------
Id Name Description ProductId OsFeedType UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
=====================================================================================================================================================================================================================================================================================
a3a49688-4601-4422-8b51-a0838ea84627 Development Default development device group 6f52bead-700d-4289-bdc2-2f11f774270e Retail Accept only system software updates. Don't accept application updates. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
7cb46b96-8c17-4afd-bd3f-614acad9d264 Field Test Default test device group 6f52bead-700d-4289-bdc2-2f11f774270e Retail Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
30c39bae-f525-4094-8008-d03705429ef0 Production Default production device group 6f52bead-700d-4289-bdc2-2f11f774270e Retail Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
cb5c9685-5dbe-470c-91a9-91dc129884d6 Production OS Evaluation Default Production OS Evaluation device group 6f52bead-700d-4289-bdc2-2f11f774270e RetailEval Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
63e72035-3fcf-4fdc-b88a-05e30d1ba224 Field Test OS Evaluation Default Field Test OS Evaluation device group 6f52bead-700d-4289-bdc2-2f11f774270e RetailEval Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- --------------------------------------------------
delete
删除 Azure Sphere 租户中的指定设备组。
只能在以下情况下删除设备组：
- 用户对租户具有管理员权限。
- 设备组为空，其中没有设备。 azsphere device-group device list 命令列出设备组中的所有设备。 运行 azsphere device update --device-group ，将设备移动到其他设备组。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -g、--device-group | 字符串 | 指定要删除的设备组。 可以指定设备组 ID 或设备组名称。 若要使用设备组名称，必须以格式提供产品名称和设备组名称 <product-name/device-group-name> 。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -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 device-group delete --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd
Successfully deleted the device group
azsphere device-group delete --device-group DW100/Development
Successfully deleted the device group
部署
管理设备组的部署。
| 操作 | 说明 |
|---|---|
| create | 为指定的设备组创建新部署。 |
| list | 显示设备组的部署。 |
deployment create …
使用提供的映像为设备组创建新部署。
可以按标识符 (ID) 或产品名称和设备组名称对标识设备组。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -g、--device-group | 字符串 | 指定要在其中创建部署的设备组。 可以指定设备组 ID 或设备组名称。 若要使用设备组名称，必须以格式提供产品名称和设备组名称 <product-name/device-group-name> 。 |
| -i、--images | 字符串 | 指定要包含在部署中的一个或多个映像的映像 ID。 可以通过添加其他参数来添加多个图像，也可以在空格分隔列表中的单个参数中组合多个图像 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，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
参数 --device-group 标识设备组。 设备组 ID 提供 GUID，用于在所有产品中唯一标识设备组。 或者，可以使用产品名称>/<device-group-name 格式的产品名称和设备组名称>对<。 这对名称唯一地标识了特定产品的设备组。
按 ID 指定设备组的示例：
azsphere device-group deployment create --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd --images 5572509b-43a4-45b0-88c5-365cbf9732c1
按名称指定设备组的示例：
azsphere device-group deployment create --device-group DW100/Development --images 5572509b-43a4-45b0-88c5-365cbf9732c1
通过提供用空格分隔的值列表来指定多个图像 ID 的示例：
azsphere device-group deployment create --device-group DW100/Development --images 5572509b-43a4-45b0-88c5-365cbf9732c1 3bbd2d2a-2870-4dde-9db8-ae50548ea7b4
应看到如下输出：
------------------------------------ ------------------------------------ ------------------------------------ ------------------------------------
Id TenantId DeployedImages DeploymentDateUtc
===================================================================================================================================================
7f860cc1-4949-4000-a541-9a988ba4c3cd 143adbc9-1bf0-4be2-84a2-084a331d81cb 5572509b-43a4-45b0-88c5-365cbf9732c1 2021-04-01T18:48:41.721662+00:00
------------------------------------ ------------------------------------ ------------------------------------ ------------------------------------
deployment list
显示设备组的部署历史记录。 返回部署 ID、时间戳和包含的映像的列表。 列表按最新部署进行排序。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -g、--device-group | 字符串 | 指定要为其显示部署历史记录列表的设备组。 可以指定设备组 ID 或设备组名称。 若要使用设备组名称，必须以格式提供产品名称和设备组名称 <product-name/device-group-name> 。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -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 device-group deployment list --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd
按名称指定设备组的示例：
azsphere device-group deployment list --device-group DW100/Development
应看到如下输出：
------------------------------------ ------------------------------------ ------------------------------------ ------------------------------------
Id TenantId DeployedImages DeploymentDateUtc
===================================================================================================================================================
7f860cc1-4949-4000-a541-9a988ba4c3cd 143adbc9-1bf0-4be2-84a2-084a331d81cb e3769536-dc4b-48d9-afd4-22ed321ba4bc 2020-11-18T19:46:50.514429+00:00
------------------------------------ ------------------------------------ ------------------------------------ ------------------------------------
device
管理设备组的设备。
| 操作 | 说明 |
|---|---|
| list | 显示设备组中的设备。 |
| show-count | 显示设备组中的设备数。 |
device list
显示设备组中的设备。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -g、--device-group | 字符串 | 指定要为其显示设备列表的设备组。 可以指定设备组 ID 或设备组名称。 若要使用设备组名称，必须以格式提供产品名称和设备组名称 <product-name/device-group-name> 。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -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 device-group device list --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd
按名称指定设备组的示例：
azsphere device-group device list --device-group DW100/Marketing
应看到如下输出：
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ----------------------------------------
DeviceId TenantId ProductId DeviceGroupId
===================================================================================================================================================================================================================================================
352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 143adbc9-1bf0-4be2-84a2-084a331d81cb 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ----------------------------------------
device show-count
显示设备组中的设备数。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -g、--device-group | 字符串 | 指定要为其显示设备计数的设备组。 可以指定设备组 ID 或设备组名称。 若要使用设备组名称，必须以格式提供产品名称和设备组名称 <product-name/device-group-name> 。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -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 device-group device show-count --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd
按名称指定设备组的示例：
azsphere device-group device show-count --device-group DW100/Marketing
应看到如下输出：
------
Result
======
1
------
显示
返回有关设备组的信息。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -g、--device-group | 字符串 | 指定要显示详细信息的设备组。 可以指定设备组 ID 或设备组名称。 若要使用设备组名称，必须以格式提供产品名称和设备组名称 <product-name/device-group-name> 。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -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 device-group show --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd
按名称指定设备组的示例：
azsphere device-group show --device-group DW100/Marketing
应看到如下输出：
------------------------------------ --------- ---------------------- ------------------------------------ ------------------------------------ ---------- ---------------------------------------------------------- ----------------------------- --------------------
Id Name Description TenantId ProductId OsFeedType UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
========================================================================================================================================================================================================================================================================
7f860cc1-4949-4000-a541-9a988ba4c3cd Marketing Marketing device group 143adbc9-1bf0-4be2-84a2-084a331d81cb 6f52bead-700d-4289-bdc2-2f11f774270e Retail Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ --------- ---------------------- ------------------------------------ ------------------------------------ ---------- ---------------------------------------------------------- ----------------------------- --------------------
update
更新按 ID 或产品名称和设备组名称对标识的现有设备组。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -g、--device-group | 字符串 | 指定要更新其详细信息的设备组。可以指定设备组 ID 或设备组名称。 若要使用设备组名称，必须以格式提供产品名称和设备组名称 <product-name/device-group-name> 。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -c、 --allow-crash-dumps-collection | 字符串 | 为设备组Microsoft设置故障转储收集的同意。 默认值为 Off。 允许的值： Off 和 On。 使用 --regional-data-boundary 参数指定应存储故障转储文件的位置。 有关详细信息，请参阅 配置故障转储。 |
| -a、 --application-update | ApplicationUpdatePolicyType | 指定设备组的应用程序更新策略。 允许的值：No3rdPartyAppUpdates、UpdateAll 和 NoUpdates。 默认值为 UpdateAll。 策略 NoUpdates 当前仅保留供内部使用。 |
| -d、--new-description | 字符串 | 指定要描述设备组的可选文本。 最大长度为 100 个字符。 |
| -n、--new-name | 字符串 | 指定设备组的新名称。 该名称只能包含字母数字字符。 如果名称包含空格，请将其用引号括起来。 设备组名称不能超过 50 个字符，不区分大小写，并且必须在产品中是唯一的。 |
| -f、--os-feed | 字符串 | 指定设备组的操作系统源。 可能的值为 Retail 和 RetailEval。 |
| -t、--tenant | GUID 或名称 | 指定要在其中执行此操作的租户。 替代默认选定的租户。 可以指定租户 ID 或租户名称。 |
| -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，请参阅 全局参数 ，了解有关可用选项的详细信息。
示例
按 ID 指定设备组的示例：
azsphere device-group update --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd --new-description "Marketing device group"
按名称指定设备组的示例：
azsphere device-group update --device-group DW100/Marketing --new-description "Marketing device group"
应看到如下输出：
------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- ----------------------------- --------------------
Id TenantId OsFeedType ProductId Name Description UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
========================================================================================================================================================================================================================================================================
7f860cc1-4949-4000-a541-9a988ba4c3cd 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 6f52bead-700d-4289-bdc2-2f11f774270e Marketing Marketing device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- ----------------------------- --------------------