az iot hub connection-string

  • リファレンス

Note

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

IoT Hub 接続文字列を管理します。

コマンド

名前 説明 型 Status
az iot hub connection-string show

指定したポリシー名とキーを使用して、指定した IoT Hub の接続文字列を表示します。

 拡張 GA

az iot hub connection-string show

指定したポリシー名とキーを使用して、指定した IoT Hub の接続文字列を表示します。

az iot hub connection-string show [--all]
                                  [--default-eventhub {false, true}]
                                  [--hub-name]
                                  [--key-type {primary, secondary}]
                                  [--pn]
                                  [--resource-group]

例

既定のポリシーと主キーを使用して、サブスクリプション内のすべてのアクティブな状態 IoT Hub の接続文字列を表示します。

az iot hub connection-string show

既定のポリシーと主キーを使用して、リソース グループ内のすべてのアクティブな状態 IoT Hub の接続文字列を表示します。

az iot hub connection-string show --resource-group MyResourceGroup

主キーを使用して、特定の IoT Hub のすべての接続文字列を表示します。

az iot hub connection-string show -n MyIotHub --all

既定のポリシーと主キーを使用して、特定の IoT Hub の接続文字列を表示します。

az iot hub connection-string show -n MyIotHub

ポリシー 'service' とセカンダリ キーを使用して、特定の IoT Hub の接続文字列を表示します。

az iot hub connection-string show -n MyIotHub --policy-name service --key-type secondary

特定の IoT Hub の既定の eventhub の eventhub 互換の接続文字列を表示します。

az iot hub connection-string show -n MyIotHub --default-eventhub

省略可能のパラメーター

--all --show-all

それぞれの IoT Hub のすべての共有アクセス ポリシーを表示します。

既定値: False
--default-eventhub --eh

返される接続文字列を示すフラグは、既定の EventHub エンドポイント用です。 既定値は false です。

承認された値: false, true
既定値: False
--hub-name -n

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

--key-type --kt

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

承認された値: primary, secondary
既定値: primary
--pn --policy-name

ターゲット IoT Hub エンティティの操作アクセス許可を持つ共有アクセス ポリシー。

既定値: iothubowner
--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 を使います。