EventHubClientOptions interface
EventHubClient の作成時に指定できるオプションについて説明します。
-
userAgent: サービスへの接続プロパティとして渡される組み込みのユーザー エージェント文字列に追加する文字列。 -
webSocketOptions: Web ソケット経由の AMQP 接続のチャネリングを構成するオプション。-
websocket: WebSocket 経由で接続する場合に AMQP 接続を作成するために使用される WebSocket コンストラクター。 -
webSocketConstructorOptions: WebSocket 経由で接続を確立するときに Websocket コンストラクターに渡すオプション。
-
-
retryOptions: クライアント/プロデューサー/コンシューマーに対するすべての操作の再試行オプション。-
maxRetries: 再試行可能なエラーが発生した場合に操作を再試行できる回数。 -
maxRetryDelayInMs: 再試行間の最大遅延。 指数再試行を実行する場合にのみ適用されます。 -
mode:RetryMode列挙型で指定された、適用する再試行モード。 オプションは、ExponentialとFixedです。 既定値はFixedです。 -
retryDelayInMs: 次の試行を行う前にミリ秒単位で待機する時間。modeがExponentialに設定されている場合、これは再試行の間に指数関数的に増加する遅延を計算するために使用されます。 既定値: 30000 ミリ秒。 -
timeoutInMs: 操作がタイムアウトするまでの待機時間 (ミリ秒単位)。これにより、再試行が残っている場合に再試行がトリガーされます。 既定値: 6,0000 ミリ秒。
-
簡単な使い方は { "maxRetries": 4 }。
使用例:
{
retryOptions: {
maxRetries: 4
}
}
プロパティ
| custom |
Event Hubs サービスに接続するときに使用するカスタム エンドポイント。 これは、ネットワークが標準の Azure Event Hubs エンドポイント アドレスへの接続を許可せず、中継局経由での接続を許可している場合に役立ちます。 例: "https://my.custom.endpoint:100/" |
| identifier | クライアントを識別するために使用される一意の名前。 指定しない場合、GUID が識別子として使用されます |
| retry |
クライアント上のすべての操作の再試行ポリシーを構成するオプション。
たとえば、 |
| user |
Event Hubs サービスに渡される組み込みのユーザー エージェント文字列に追加される値。 |
| web |
Web ソケット経由の AMQP 接続のチャネリングを構成するオプション。 |
プロパティの詳細
customEndpointAddress
Event Hubs サービスに接続するときに使用するカスタム エンドポイント。 これは、ネットワークが標準の Azure Event Hubs エンドポイント アドレスへの接続を許可せず、中継局経由での接続を許可している場合に役立ちます。
例: "https://my.custom.endpoint:100/"
customEndpointAddress?: stringプロパティ値
string
identifier
クライアントを識別するために使用される一意の名前。 指定しない場合、GUID が識別子として使用されます
identifier?: stringプロパティ値
string
retryOptions
クライアント上のすべての操作の再試行ポリシーを構成するオプション。
たとえば、{ "maxRetries": 4 } や { "maxRetries": 4, "retryDelayInMs": 30000 }などです。
retryOptions?: RetryOptionsプロパティ値
userAgent
Event Hubs サービスに渡される組み込みのユーザー エージェント文字列に追加される値。
userAgent?: stringプロパティ値
string