az iot du device group

Note

このリファレンスは、Azure CLI (バージョン 2.67.0 以降) の azure-iot 拡張機能の一部です。拡張機能は、az iot du device group コマンドを初めて実行すると、自動的にインストールされます。拡張機能の詳細については、を参照してください。

デバイスグループの管理。

デバイスグループは、デバイスのコレクションです。デバイスグループによって、多数のデバイスへ配置をスケーリングする方法が提供されます。各デバイスは、一度に 1 つのデバイスグループにだけ属します。デバイス更新が有効なデバイスがハブに接続され、そのプロパティが報告されると、デバイスグループが自動的に作成されます。

コマンド

名前	説明	型	状態
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

必須のパラメーター

--account -n

Device Update アカウント名。 az config set defaults.adu_account={name}を使用して、既定のアカウント名を構成できます。

プロパティ	値
パラメーターグループ:	Account Identifier Arguments

--gid --group-id

デバイスグループ ID。これは、接続されている IoT Hub のデバイス/モジュールツインの ADUGroup タグの値から作成されるか、タグのないデバイスの$defaultから作成されます。

--instance -i

デバイス更新インスタンス名。 az config set defaults.adu_instance={name}を使用して、既定のインスタンス名を構成できます。

プロパティ	値
パラメーターグループ:	Account Identifier Arguments

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--resource-group -g

Device Update アカウントのリソースグループ名。 az config set defaults.adu_group={name}を使用して既定のグループを構成できます。

プロパティ	値
パラメーターグループ:	Account Identifier Arguments

--yes -y

ユーザープロンプトをスキップします。アクションの受け入れを示します。主に自動化シナリオに使用されます。既定値: false。

プロパティ	値
指定可能な値:	false, true

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --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

必須のパラメーター

--account -n

Device Update アカウント名。 az config set defaults.adu_account={name}を使用して、既定のアカウント名を構成できます。

プロパティ	値
パラメーターグループ:	Account Identifier Arguments

--instance -i

デバイス更新インスタンス名。 az config set defaults.adu_instance={name}を使用して、既定のインスタンス名を構成できます。

プロパティ	値
パラメーターグループ:	Account Identifier Arguments

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--order-by

返されるグループのセットを注文します。 groupId、deviceCount、createdDateTime、サブグループWithNewUpdatesAvailableCount、サブグループWithUpdatesInProgressCount、またはサブグループWithOnLatestUpdateCount で並べ替えることができます。

--resource-group -g

Device Update アカウントのリソースグループ名。 az config set defaults.adu_group={name}を使用して既定のグループを構成できます。

プロパティ	値
パラメーターグループ:	Account Identifier Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --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

必須のパラメーター

--account -n

Device Update アカウント名。 az config set defaults.adu_account={name}を使用して、既定のアカウント名を構成できます。

プロパティ	値
パラメーターグループ:	Account Identifier Arguments

--gid --group-id

--instance -i

デバイス更新インスタンス名。 az config set defaults.adu_instance={name}を使用して、既定のインスタンス名を構成できます。

プロパティ	値
パラメーターグループ:	Account Identifier Arguments

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--best-updates

各更新プログラムが必要なデバイスの数など、デバイスグループに最適な更新プログラムをフェッチする必要があることを示すフラグ。最適な更新プログラムは、デバイスクラスのすべての互換性仕様を満たす最新の更新プログラムです。

プロパティ	値
パラメーターグループ:	Update Arguments
指定可能な値:	false, true

--resource-group -g

Device Update アカウントのリソースグループ名。 az config set defaults.adu_group={name}を使用して既定のグループを構成できます。

プロパティ	値
パラメーターグループ:	Account Identifier Arguments

--update-compliance

コマンドがデバイスグループ更新プログラムのコンプライアンス情報をフェッチする必要があることを示すフラグ (最新の更新プログラムのデバイスの数、新しい更新プログラムが必要な数、新しい更新プログラムの受信中の数など)。

プロパティ	値
パラメーターグループ:	Update Arguments
指定可能な値:	false, true

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

フィードバック

このページはお役に立ちましたか?

次の方法で共有

az iot du device group

コマンド

az iot du device group delete

例

必須のパラメーター

オプションのパラメーター

az iot du device group list

例

必須のパラメーター

オプションのパラメーター

az iot du device group show

例

必須のパラメーター

オプションのパラメーター

フィードバック