EventHubsConnectionStringBuilder クラス

  • リファレンス

定義

名前空間:
Microsoft.Azure.EventHubs
アセンブリ:
Microsoft.Azure.EventHubs.dll
パッケージ:
Microsoft.Azure.EventHubs v4.3.2
ソース:
EventHubsConnectionStringBuilder.cs

EventHubsConnectionStringBuilder を使用して、Event Hubs エンティティとの通信を確立できる接続文字列を構築できます。 また、既存の接続文字列に対して基本的な検証を実行するためにも使用できます。

接続文字列は、基本的に";" で区切られたキーと値のペアで構成される文字列です。 基本形式は "<key>=<value>[;<key>=<value>]" です。サポートされているキー名は次のとおりです。

エンドポイント - Event Hubs 名前空間を含む URL

EntityPath - Event Hub エンティティへのパス

SharedAccessKeyName - 名前空間またはエンティティの対応する共有アクセス ポリシー規則のキー名。

SharedAccessKey - 名前空間またはエンティティの対応する共有アクセス ポリシー規則のキー。 
public class EventHubsConnectionStringBuilder
type EventHubsConnectionStringBuilder = class
Public Class EventHubsConnectionStringBuilder
継承
Object
EventHubsConnectionStringBuilder

例

サンプル コード:

var connectionStringBuiler = new EventHubsConnectionStringBuilder(
    "amqps://EventHubsNamespaceName.servicebus.windows.net", 
    "EventHubsEntityName", // Event Hub Name 
    "SharedAccessSignatureKeyName", 
    "SharedAccessSignatureKey");
 string connectionString = connectionStringBuiler.ToString();

コンストラクター

EventHubsConnectionStringBuilder(String)

ConnectionString 形式: Endpoint=sb://namespace_DNS_Name;EntityPath=EVENT_HUB_NAME;SharedAccessKeyName=SHARED_ACCESS_KEY_NAME;SharedAccessKey=SHARED_ACCESS_KEY
EventHubsConnectionStringBuilder(Uri, String, String, String)

次の方法で使用できる接続文字列を作成します。 CreateFromConnectionString(String)
EventHubsConnectionStringBuilder(Uri, String, String, String, TimeSpan)

次の方法で使用できる接続文字列を作成します。 CreateFromConnectionString(String)
EventHubsConnectionStringBuilder(Uri, String, String, TimeSpan)

次の方法で使用できる接続文字列を作成します。 CreateFromConnectionString(String)

プロパティ

Authentication

[マネージド ID] に設定されている場合に Azure Active Directory マネージド ID 認証を有効にします
Endpoint

Event Hubs エンドポイントを取得または設定します。
EntityPath

接続文字列からエンティティ パスの値を取得する
OperationTimeout

OperationTimeout が誤った状況で適用され、呼び出し元に関連する EventHubsException
SasKey

接続文字列から共有アクセス ポリシー キーの値を取得する
SasKeyName

接続文字列から共有アクセス ポリシーの所有者名を取得する
SharedAccessSignature

SAS アクセス トークンを取得または設定します。
TransportType

クライアント接続のトランスポートの種類。 使用できるオプションは、Amqp と AmqpWebSocket です。 指定しない場合、既定値は Amqp です。

メソッド

Clone()

現在 EventHubsConnectionStringBuilderの の複製オブジェクトを作成します。
ToString()

Event Hubs 名前空間への接続に使用できる相互運用可能な接続文字列を返します。

適用対象