az iot hub device-identity children

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 拡張機能は、az iot hub device-identity children コマンドを初めて実行すると、自動的にインストールされます。 Learn more about extensions.

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

コマンド

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

az iot hub device-identity children add

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

az iot hub device-identity children add --child-list --cl
                                        --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。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

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

プロパティ	値
Parameter group:	Access Control Arguments
規定値:	key
指定可能な値:	key, login

--force -f

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

プロパティ	値
規定値:	False

--hub-name -n

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

プロパティ	値
Parameter group:	IoT Hub Identifier Arguments

--login -l

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

プロパティ	値
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 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。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

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

プロパティ	値
Parameter group:	Access Control Arguments
規定値:	key
指定可能な値:	key, login

--hub-name -n

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

プロパティ	値
Parameter group:	IoT Hub Identifier Arguments

--login -l

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

プロパティ	値
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 hub device-identity children remove

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

az iot hub device-identity children remove --device-id
                                           [--auth-type {key, login}]
                                           [--child-list --cl]
                                           [--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。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

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

プロパティ	値
Parameter group:	Access Control Arguments
規定値:	key
指定可能な値:	key, login

--child-list --cl

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

--hub-name -n

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

プロパティ	値
Parameter group:	IoT Hub Identifier Arguments

--login -l

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

プロパティ	値
Parameter group:	IoT Hub Identifier Arguments

--remove-all -a

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

プロパティ	値
規定値:	False

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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