az iot du device group

注意

此參考是 Azure CLI 的 azure-iot 延伸模組的一部分（2.46.0 版或更高版本）。 擴充功能會在您第一次執行 az iot du device group 命令時自動安裝。 深入了解擴充功能。

裝置群組管理。

裝置群組是裝置的集合。 裝置群組可讓您調整多個裝置的部署。 每個裝置分別屬於一個裝置群組。 當啟用裝置更新的裝置連線到中樞並報告其屬性時，會自動建立裝置群組。

命令

名稱	Description	類型	狀態
az iot du device group delete	刪除裝置群組。	副檔名	GA
az iot du device group list	列出實例內的裝置群組。	副檔名	GA
az iot du device group show	顯示裝置群組的詳細數據，包括最佳更新和更新合規性。	副檔名	GA

az iot du device group delete

刪除裝置群組。

裝置群組不會自動清除，但會保留供歷程記錄之用。 如果群組不需要或需要保留其歷程記錄，則可以使用此作業。 如果裝置在刪除群組后再次連線到群組，系統就會自動重新建立，且沒有歷程記錄。

az iot du device group delete --account
                              --gid
                              --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

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name>。

--gid --group-id

裝置群組標識碼。這會從連線 IoT 中樞 裝置/模組對應項中的 ADUGroup 標記值建立，或針對沒有標記的裝置建立$default。

--instance -i

裝置更新實例名稱。 您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name>。

選擇性參數

--resource-group -g

裝置更新帳戶資源組名。 您可以使用 az config set defaults.adu_group=<name> 來設定預設群組。

--yes -y

略過使用者提示。 表示接受動作。 主要用於自動化案例。 預設：false。

接受的值: false, true

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

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

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name>。

--instance -i

裝置更新實例名稱。 您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name>。

選擇性參數

--order-by

排序傳回的群組集。 您可以依 groupId、deviceCount、createdDateTime、subgroupsWithNewUpdatesAvailableCount、subgroupsWithUpdatesInProgressCount 或 subgroupsWithOnLatestUpdateCount 排序。

--resource-group -g

裝置更新帳戶資源組名。 您可以使用 az config set defaults.adu_group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot du device group show

顯示裝置群組的詳細數據，包括最佳更新和更新合規性。

az iot du device group show --account
                            --gid
                            --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

必要參數

--account -n

裝置更新帳戶名稱。 您可以使用 來設定預設帳戶名稱 az config set defaults.adu_account=<name>。

--gid --group-id

裝置群組標識碼。這會從連線 IoT 中樞 裝置/模組對應項中的 ADUGroup 標籤建立，或針對沒有標記的裝置建立$default。

--instance -i

裝置更新實例名稱。 您可以使用 來設定預設實例名稱 az config set defaults.adu_instance=<name>。

選擇性參數

--best-updates

指出命令的旗標應該擷取裝置群組的最佳可用更新，包括每個更新需要多少裝置計數。 最佳更新是符合裝置類別所有相容性規格的最新更新。

接受的值: false, true

--resource-group -g

裝置更新帳戶資源組名。 您可以使用 az config set defaults.adu_group=<name> 來設定預設群組。

--update-compliance

指出命令的旗標應該擷取裝置群組更新合規性資訊，例如其最新更新上的裝置數目、需要多少新更新，以及接收新更新時有多少個正在進行中。

接受的值: false, true

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。