az iot du device group
Note
此参考是 Azure CLI(版本 2.67.0 或更高版本)的 azure-iot 扩展的一部分。 该扩展将在首次运行 az iot du device group 命令时自动安装。 了解更多关于扩展的信息。
设备组管理。
设备组是设备的集合。 可通过设备组将部署扩展到多台设备。 每台设备一次只属于一个设备组。 当启用了设备更新的设备连接到中心并报告其属性时,会自动创建设备组。
命令
| 名称 | 说明 | 类型 | Status |
|---|---|---|---|
| az iot du device group delete |
删除设备组。 |
Extension | GA |
| az iot du device group list |
列出实例中的设备组。 |
Extension | GA |
| az iot du device group show |
显示有关设备组的详细信息,包括最佳更新和更新符合性。 |
Extension | GA |
az iot du device group delete
删除设备组。
设备组不会自动清理,但会出于历史记录目的保留。 如果不需要组或需要保留该组的历史记录,则可以使用此操作。 如果设备在删除组后再次为组连接,将自动重新创建,且没有历史记录。
az iot du device group delete --account
--gid --group-id
--instance
[--resource-group]
[--yes {false, true}]
示例
删除设备组。
az iot du device group delete -n {account_name} -i {instance_name} --group-id {device_group_id}
删除跳过确认提示的设备组。
az iot du device group delete -n {account_name} -i {instance_name} --group-id {device_group_id} -y
必需参数
设备更新帐户名称。 可以使用 az config set defaults.adu_account={name}配置默认帐户名称。
| 属性 | 值 |
|---|---|
| 参数组: | Account Identifier Arguments |
设备组 ID。这是从连接的 IoT 中心设备/模块孪生中的 ADUGroup 标记的值创建的,或者为没有标记的设备创建$default。
设备更新实例名称。 可以使用 az config set defaults.adu_instance={name}配置默认实例名称。
| 属性 | 值 |
|---|---|
| 参数组: | Account Identifier Arguments |
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
设备更新帐户资源组名称。 可以使用 az config set defaults.adu_group={name}配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Account Identifier Arguments |
跳过用户提示。 指示接受操作。 主要用于自动化方案。 默认值:false。
| 属性 | 值 |
|---|---|
| 接受的值: | false, true |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az iot du device group list
列出实例中的设备组。
az iot du device group list --account
--instance
[--order-by]
[--resource-group]
示例
列出设备组。
az iot du device group list -n {account_name} -i {instance_name}
按所需顺序列出设备组,在本例中按 deviceCount 列出。
az iot du device group list -n {account_name} -i {instance_name} --order-by deviceCount
必需参数
设备更新帐户名称。 可以使用 az config set defaults.adu_account={name}配置默认帐户名称。
| 属性 | 值 |
|---|---|
| 参数组: | Account Identifier Arguments |
设备更新实例名称。 可以使用 az config set defaults.adu_instance={name}配置默认实例名称。
| 属性 | 值 |
|---|---|
| 参数组: | Account Identifier Arguments |
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
对返回的组集进行排序。 可以按 groupId、deviceCount、createdDateTime、subgroupsWithNewUpdatesAvailableCount、subgroupsWithUpdatesInProgressCount 或 subgroupsWithOnLatestUpdateCount 排序。
设备更新帐户资源组名称。 可以使用 az config set defaults.adu_group={name}配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Account Identifier Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az iot du device group show
显示有关设备组的详细信息,包括最佳更新和更新符合性。
az iot du device group show --account
--gid --group-id
--instance
[--best-updates {false, true}]
[--resource-group]
[--update-compliance {false, true}]
示例
显示设备组。
az iot du device group show -n {account_name} -i {instance_name} --group-id {device_group_id}
显示可用于设备组的最佳更新。 此标志修改命令以返回列表。
az iot du device group show -n {account_name} -i {instance_name} --group-id {device_group_id} --best-updates
显示设备组的更新符合性。
az iot du device group show -n {account_name} -i {instance_name} --group-id {device_group_id} --update-compliance
必需参数
设备更新帐户名称。 可以使用 az config set defaults.adu_account={name}配置默认帐户名称。
| 属性 | 值 |
|---|---|
| 参数组: | Account Identifier Arguments |
设备组 ID。这是从连接的 IoT 中心设备/模块孪生中的 ADUGroup 标记的值创建的,或者为没有标记的设备创建$default。
设备更新实例名称。 可以使用 az config set defaults.adu_instance={name}配置默认实例名称。
| 属性 | 值 |
|---|---|
| 参数组: | Account Identifier Arguments |
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
指示命令应提取设备组的最佳可用更新的标志,包括每个更新需要多少台设备的计数。 最佳更新是符合设备类的所有兼容性规范的最新更新。
| 属性 | 值 |
|---|---|
| 参数组: | Update Arguments |
| 接受的值: | false, true |
设备更新帐户资源组名称。 可以使用 az config set defaults.adu_group={name}配置默认组。
| 属性 | 值 |
|---|---|
| 参数组: | Account Identifier Arguments |
指示命令应提取设备组更新符合性信息的标志,例如最新更新中的设备数、需要多少个新更新,以及接收新更新时正在进行多少个更新。
| 属性 | 值 |
|---|---|
| 参数组: | Update Arguments |
| 接受的值: | false, true |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |