az iot hub device-identity children

リファレンス

Note

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

IoT エッジデバイスの子デバイスリレーションシップを管理します。

コマンド

名前	説明	型	状態
az iot hub device-identity children add	デバイスを子としてターゲットエッジデバイスに追加します。	拡張子	GA
az iot hub device-identity children list	割り当てられた子デバイスのコレクションを出力します。	拡張子	GA
az iot hub device-identity children remove	ターゲットエッジデバイスから子デバイスを削除します。	拡張子	GA

az iot hub device-identity children add

デバイスを子としてターゲットエッジデバイスに追加します。

az iot hub device-identity children add --child-list
                                        --device-id
                                        [--auth-type {key, login}]
                                        [--force]
                                        [--hub-name]
                                        [--login]
                                        [--resource-group]

例

デバイス ID のスペース区切りの一覧を子としてターゲットエッジデバイスに追加します。

az iot hub device-identity children add -d {edge_device_id} --child-list {child_device_id_1} {child_device_id_2} -n {iothub_name}

デバイスを子としてエッジデバイスに追加し、子デバイスの既存の親を上書きします。

az iot hub device-identity children add -d {edge_device_id} --child-list {child_device_id_1} {child_device_id_2} -n {iothub_name} -f

必須のパラメーター

--child-list --cl

子デバイスの一覧 (スペース区切り)。

--device-id -d

エッジデバイスの ID。

省略可能のパラメーター

--auth-type

操作でポリシーキーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>既定値を構成できます。

指定可能な値: key, login

規定値: key

--force -f

子デバイスの親デバイスを上書きします。

規定値: False

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--login -l

このコマンドは、アクションを実行する権限を持つエンティティ接続文字列をサポートします。 "az login" によるセッションログインを回避するために使用します。エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。

--resource-group -g

リソースグループの名前。 az configure --defaults 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 hub device-identity children list

割り当てられた子デバイスのコレクションを出力します。

az iot hub device-identity children list --device-id
                                         [--auth-type {key, login}]
                                         [--hub-name]
                                         [--login]
                                         [--resource-group]

例

割り当てられているすべての子デバイスを一覧表示します。

az iot hub device-identity children list -d {edge_device_id} -n {iothub_name}

デバイス ID に 'test' の部分文字列が含まれている、割り当てられたすべての子デバイスを一覧表示します。

az iot hub device-identity children list -d {edge_device_id} -n {iothub_name} --query "[?contains(@,'test')]"

必須のパラメーター

--device-id -d

エッジデバイスの ID。

省略可能のパラメーター

--auth-type

指定可能な値: key, login

規定値: key

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--login -l

--resource-group -g

リソースグループの名前。 az configure --defaults 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 hub device-identity children remove

ターゲットエッジデバイスから子デバイスを削除します。

az iot hub device-identity children remove --device-id
                                           [--auth-type {key, login}]
                                           [--child-list]
                                           [--hub-name]
                                           [--login]
                                           [--remove-all]
                                           [--resource-group]

例

ターゲットの親デバイスから、スペースで区切られた子デバイスの一覧を削除します。

az iot hub device-identity children remove -d {edge_device_id} --child-list {space_separated_device_id} -n {iothub_name}

ターゲットの親デバイスからすべての子デバイスを削除します。

az iot hub device-identity children remove -d {edge_device_id} --remove-all

必須のパラメーター

--device-id -d

エッジデバイスの ID。

省略可能のパラメーター

--auth-type

指定可能な値: key, login

規定値: key

--child-list --cl

子デバイスの一覧 (スペース区切り)。

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--login -l

--remove-all -a

すべての子を削除します。

規定値: False

--resource-group -g

リソースグループの名前。 az configure --defaults 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 hub device-identity children

コマンド

az iot hub device-identity children add

例

必須のパラメーター

省略可能のパラメーター

az iot hub device-identity children list

例

必須のパラメーター

省略可能のパラメーター

az iot hub device-identity children remove

例

必須のパラメーター

省略可能のパラメーター

その他のリソース