az iot du device group
Note
このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot du device group コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
デバイス グループの管理。
デバイス グループは、デバイスのコレクションです。 デバイス グループによって、多数のデバイスへ配置をスケーリングする方法が提供されます。 各デバイスは、一度に 1 つのデバイス グループにだけ属します。 デバイス 更新が有効なデバイスがハブに接続され、そのプロパティが報告されると、デバイス グループが自動的に作成されます。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
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
必須のパラメーター
Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>
構成できます。
デバイス グループ ID。これは、接続されている IoT Hub のデバイス/モジュール ツインの ADUGroup タグの値から作成されるか、タグのないデバイスの$defaultから作成されます。
デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>
構成できます。
省略可能のパラメーター
Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name>
を使用して、既定のグループを構成できます。
ユーザー プロンプトをスキップします。 アクションの受け入れを示します。 主に自動化シナリオに使用されます。 既定値は false です。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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
必須のパラメーター
Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>
構成できます。
デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>
構成できます。
省略可能のパラメーター
返されるグループのセットを注文します。 groupId、deviceCount、createdDateTime、サブグループWithNewUpdatesAvailableCount、サブグループWithUpdatesInProgressCount、またはサブグループWithOnLatestUpdateCount で並べ替えることができます。
Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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
必須のパラメーター
Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>
構成できます。
デバイス グループ ID。これは、接続されている IoT Hub のデバイス/モジュール ツインの ADUGroup タグの値から作成されるか、タグのないデバイスの$defaultから作成されます。
デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>
構成できます。
省略可能のパラメーター
各更新プログラムが必要なデバイスの数など、デバイス グループに最適な更新プログラムをフェッチする必要があることを示すフラグ。 最適な更新プログラムは、デバイス クラスのすべての互換性仕様を満たす最新の更新プログラムです。
Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name>
を使用して、既定のグループを構成できます。
コマンドがデバイス グループ更新プログラムのコンプライアンス情報をフェッチする必要があることを示すフラグ (最新の更新プログラムのデバイスの数、新しい更新プログラムが必要な数、新しい更新プログラムの受信中の数など)。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI