ConnectionString class
デバイスまたはクラウド アプリケーションが Azure IoT ハブに接続できるようにするパラメーターについて説明します。
プロパティ
| Device |
デバイス ID レジストリに存在する一意のデバイス識別子。 これは、デバイス接続文字列にのみ使用されます。 |
| Gateway |
デバイスまたはプロトコル ゲートウェイとして動作するホスト コンピューターの IP アドレスまたはインターネット名。 Azure Edge デバイスと通信するときに使用されます。 |
| Host |
Azure IoT ハブのホスト名。 |
| Module |
デバイス ID レジストリに存在する一意のモジュール識別子。 これは、デバイス接続文字列にのみ使用されます。 |
| Shared |
接続の認証に使用される共有アクセス署名トークンの作成に使用される対称キー。 特定のデバイスまたは特定のサービス ポリシーに関連付けられます。 |
| Shared |
Azure IoT ハブへの接続に使用されるアクセス ポリシーの名前。 サービス SDK の場合にのみ使用されます。Device SDK では使用されません (代わりに を使用 |
| Shared |
IoT ハブに対する "デバイス接続" アクセス許可をカプセル化する共有アクセス署名。 |
| x509 | このプロパティは、デバイスが認証に x509 証明書を使用し、存在する場合は True に設定されている場合にのみ存在します。 |
メソッド
| parse(string, string[]) | 文字列を解析し、対応する ConnectionString オブジェクトを返します。 |
プロパティの詳細
DeviceId
デバイス ID レジストリに存在する一意のデバイス識別子。 これは、デバイス接続文字列にのみ使用されます。
DeviceId?: stringプロパティ値
string
GatewayHostName
デバイスまたはプロトコル ゲートウェイとして動作するホスト コンピューターの IP アドレスまたはインターネット名。 Azure Edge デバイスと通信するときに使用されます。
GatewayHostName?: stringプロパティ値
string
HostName
Azure IoT ハブのホスト名。
HostName?: stringプロパティ値
string
ModuleId
デバイス ID レジストリに存在する一意のモジュール識別子。 これは、デバイス接続文字列にのみ使用されます。
ModuleId?: stringプロパティ値
string
SharedAccessKey
接続の認証に使用される共有アクセス署名トークンの作成に使用される対称キー。 特定のデバイスまたは特定のサービス ポリシーに関連付けられます。
SharedAccessKey?: stringプロパティ値
string
SharedAccessKeyName
Azure IoT ハブへの接続に使用されるアクセス ポリシーの名前。 サービス SDK の場合にのみ使用されます。Device SDK では使用されません (代わりに を使用 DeviceId します)。
SharedAccessKeyName?: stringプロパティ値
string
SharedAccessSignature
IoT ハブに対する "デバイス接続" アクセス許可をカプセル化する共有アクセス署名。
SharedAccessSignature?: stringプロパティ値
string
x509
このプロパティは、デバイスが認証に x509 証明書を使用し、存在する場合は True に設定されている場合にのみ存在します。
x509?: stringプロパティ値
string
メソッドの詳細
parse(string, string[])
文字列を解析し、対応する ConnectionString オブジェクトを返します。
static function parse(source: string, requiredFields?: string[]): ConnectionStringパラメーター
- source
-
string
接続文字列の抽出元となる文字列
- requiredFields
-
string[]
見つかると予想されるフィールドを一覧表示する文字列の配列。