az iot hub device-identity parent

注

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

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

コマンド

名前	説明	型	状態
az iot hub device-identity parent set	ターゲット デバイスの親デバイスを設定します。	拡張	GA
az iot hub device-identity parent show	ターゲット デバイスの親デバイスを取得します。	拡張	GA

az iot hub device-identity parent set

ターゲット デバイスの親デバイスを設定します。

az iot hub device-identity parent set --device-id
                                      --parent-device-id
                                      [--auth-type {key, login}]
                                      [--force]
                                      [--hub-name]
                                      [--login]
                                      [--resource-group]

例

ターゲット デバイスの親デバイスを設定します。

az iot hub device-identity parent set -d {device_id} --pd {edge_device_id} -n {iothub_name}

ターゲット デバイスの親デバイスを設定し、既存の親を上書きします。

az iot hub device-identity parent set -d {device_id} --pd {edge_device_id} -n {iothub_name} --force

必須のパラメーター

--device-id -d

ターゲット デバイス ID。

--parent-device-id --pd

エッジ デバイスの 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 parent show

ターゲット デバイスの親デバイスを取得します。

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

例

ターゲット デバイスの親デバイスを取得します。

az iot hub device-identity parent show -d {device_id} -n {iothub_name}

必須のパラメーター

--device-id -d

ターゲット デバイス ID。

省略可能のパラメーター

--auth-type

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

指定可能な値: key, login

規定値: key

--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 を使用します。