az iot dps connection-string
Note
This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 拡張機能は、az iot dps 接続文字列 コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.
Azure IoT Hub Device Provisioning Service インスタンスの接続文字列を管理します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az iot dps connection-string show |
指定したポリシー名とキーを使用して、指定した Device Provisioning Services の接続文字列を表示します。 |
Extension | GA |
az iot dps connection-string show
指定したポリシー名とキーを使用して、指定した Device Provisioning Services の接続文字列を表示します。
az iot dps connection-string show [--all --show-all]
[--dps-name]
[--key-type --kt {primary, secondary}]
[--pn --policy-name]
[--resource-group]
例
既定のポリシーと主キーを使用して、サブスクリプション内のすべてのアクティブな状態 DPS インスタンスの接続文字列を表示します。
az iot dps connection-string show
既定のポリシーと主キーを使用して、リソース グループ内のすべてのアクティブな状態 DPS インスタンスの接続文字列を表示します。
az iot dps connection-string show --resource-group MyResourceGroup
主キーを使用して、指定された DPS のすべての接続文字列を表示します。
az iot dps connection-string show -n MyDPS --all
既定のポリシーと主キーを使用して、指定された DPS の接続文字列を表示します。
az iot dps connection-string show -n MyDPS
ポリシー 'service' とセカンダリ キーを使用して、指定された DPS の接続文字列を表示します。
az iot dps connection-string show -n MyDPS --policy-name service --key-type secondary
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
それぞれの DPS のすべての共有アクセス ポリシーを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
Azure IoT Hub Device Provisioning Service の名前またはホスト名。 --login が指定されていない場合は必須。
プロパティ | 値 |
---|---|
Parameter group: | Device Provisioning Service Identifier Arguments |
認証用の共有アクセス ポリシー キーの種類。
プロパティ | 値 |
---|---|
規定値: | primary |
指定可能な値: | primary, secondary |
認証に使用する共有アクセス ポリシー。
プロパティ | 値 |
---|---|
規定値: | provisioningserviceowner |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |