az iot du device class

  • リファレンス

Note

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

デバイス クラスとデバイス クラスサブグループの管理。

デバイス クラスは、グループ間で共通の属性セットを共有するデバイスのセットを表しますが、デバイス クラス サブグループは、同じデバイス クラス ID を共有するグループ内のデバイスのサブセットです。デバイス の更新が有効なデバイスがハブに接続されると、デバイス クラスが自動的に作成されます。

コマンド

名前 説明 型 Status
az iot du device class delete

デバイス クラスまたはデバイス クラス サブグループを削除します。

 拡張 GA
az iot du device class list

デバイス クラスまたはデバイス クラス サブグループを一覧表示します。

 拡張 GA
az iot du device class show

インストール可能な更新プログラム、最適な更新プログラム、更新プログラムのコンプライアンスなど、デバイス クラスまたはデバイス クラスサブグループに関する詳細を表示します。

 拡張 GA
az iot du device class update

デバイス クラスを更新します。

 拡張 GA

az iot du device class delete

デバイス クラスまたはデバイス クラス サブグループを削除します。

デバイス クラスは、デバイス更新対応デバイスがハブに接続されているときに自動的に作成されますが、デバイス クラスサブグループによって参照されるため、自動的にクリーンされません。 ターゲット デバイス クラスのすべてのデバイス クラス サブグループが削除された場合、デバイス クラス自体を削除して、システムからレコードを削除したり、デバイス クラスと新しい更新プログラムの互換性のチェックを停止したりすることもできます。 デバイスが再接続された場合、デバイス クラスが存在しない場合は再作成されます。

az iot du device class delete --account
                              --cid
                              --instance
                              [--gid]
                              [--resource-group]
                              [--yes {false, true}]

例

デバイス クラスを削除します。

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id}

デバイス クラスを削除し、確認プロンプトをスキップします。

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} -y

デバイス クラス サブグループを削除します。

az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id}

必須のパラメーター

--account -n

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

--cid --class-id

デバイス クラス ID。これは、IoT Hub の Device Update PnP インターフェイスでデバイス更新エージェントによって報告されるモデル ID と互換性プロパティから生成されます。 これは、16 進数でエンコードされた SHA1 ハッシュです。

--instance -i

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

省略可能のパラメーター

--gid --group-id

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

--resource-group -g

Device Update アカウントのリソース グループ名。 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

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot du device class list

デバイス クラスまたはデバイス クラス サブグループを一覧表示します。

az iot du device class list --account
                            --instance
                            [--filter]
                            [--gid]
                            [--resource-group]

例

インスタンス内のデバイス クラスを一覧表示します。

az iot du device class list -n {account_name} -i {instance_name}

フレンドリ名でフィルター処理されたインスタンス デバイス クラスを一覧表示します。

az iot du device class list -n {account_name} -i {instance_name} --filter "friendlyName eq 'my-favorite-class'"

グループのデバイス クラス サブグループを一覧表示します。

az iot du device class list -n {account_name} -i {instance_name} --group-id {device_group_id}

compatProperties/manufacturer でフィルター処理されたグループのデバイス クラス サブグループを一覧表示します。

az iot du device class list -n {account_name} -i {instance_name} --group-id {device_group_id} --filter "compatProperties/manufacturer eq 'Contoso'"

必須のパラメーター

--account -n

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

--instance -i

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

省略可能のパラメーター

--filter

--group-id を指定した場合、デバイス クラスの互換性プロパティの名前と値に基づくフィルター処理がサポートされます。 たとえば、"compatProperties/manufacturer eq 'Contoso' などです。 それ以外の場合は、クラスのフレンドリ名によるフィルター処理がサポートされます。

--gid --group-id

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

--resource-group -g

Device Update アカウントのリソース グループ名。 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

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot du device class show

インストール可能な更新プログラム、最適な更新プログラム、更新プログラムのコンプライアンスなど、デバイス クラスまたはデバイス クラスサブグループに関する詳細を表示します。

az iot du device class show --account
                            --cid
                            --instance
                            [--best-update {false, true}]
                            [--gid]
                            [--installable-updates {false, true}]
                            [--resource-group]
                            [--update-compliance {false, true}]

例

デバイス クラスを表示します。

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id}

デバイス クラスのインストール可能な更新プログラムを表示します。 このフラグは、リストを返すようにコマンドを変更します。

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --installable-updates

デバイス クラスサブグループを表示します。

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id}

デバイス クラス サブグループで使用可能な最適な更新プログラムを表示します。

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id} --best-update

デバイス クラス サブグループの更新プログラムのコンプライアンスを表示します。

az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id} --update-compliance

必須のパラメーター

--account -n

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

--cid --class-id

デバイス クラス ID。これは、IoT Hub の Device Update PnP インターフェイスでデバイス更新エージェントによって報告されるモデル ID と互換性プロパティから生成されます。 これは、16 進数でエンコードされた SHA1 ハッシュです。

--instance -i

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

省略可能のパラメーター

--best-update

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

承認された値: false, true
--gid --group-id

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

--installable-updates

コマンドがデバイス クラスのインストール可能な更新プログラムをフェッチする必要があることを示すフラグ。

承認された値: false, true
--resource-group -g

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

--update-compliance

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

承認された値: false, true
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot du device class update

デバイス クラスを更新します。

az iot du device class update --account
                              --cid
                              --instance
                              [--friendly-name]
                              [--resource-group]

例

デバイス クラスのフレンドリ名を更新します。

az iot du device class update -n {account_name} -i {instance_name} --class-id {device_class_id} --friendly-name "EU-region"

必須のパラメーター

--account -n

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

--cid --class-id

デバイス クラス ID。これは、IoT Hub の Device Update PnP インターフェイスでデバイス更新エージェントによって報告されるモデル ID と互換性プロパティから生成されます。 これは、16 進数でエンコードされた SHA1 ハッシュです。

--instance -i

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

省略可能のパラメーター

--friendly-name

デバイス クラスのフレンドリ名。 フレンドリ名は 1 ~ 100 文字にする必要があり、英数字、ドット、ダッシュの値をサポートします。

--resource-group -g

Device Update アカウントのリソース グループ名。 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

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。