az iot hub device-identity connection-string

Note

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

IoT デバイスの接続文字列を管理します。

コマンド

名前	説明	型	状態
az iot hub device-identity connection-string show	特定の IoT Hub デバイス 接続文字列を表示します。	Extension	GA

az iot hub device-identity connection-string show

特定の IoT Hub デバイス 接続文字列を表示します。

az iot hub device-identity connection-string show --device-id
                                                  [--auth-type {key, login}]
                                                  [--hub-name]
                                                  [--key-type --kt {primary, secondary}]
                                                  [--login]
                                                  [--resource-group]

必須のパラメーター

--device-id -d

ターゲット デバイス ID。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--auth-type

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

プロパティ	値
パラメーター グループ:	Access Control Arguments
規定値:	key
指定可能な値:	key, login

--hub-name -n

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--key-type --kt

認証用の共有アクセス ポリシー キーの種類。

プロパティ	値
規定値:	primary
指定可能な値:	primary, secondary

--login -l

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

プロパティ	値
パラメーター グループ:	IoT Hub Identifier Arguments

--resource-group -g

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

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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