EventHubConsumerClientOptions interface

  • リファレンス
パッケージ:
@azure/event-hubs

EventHubConsumerClient の作成時に指定できるオプションについて説明します。

  • loadBalancingOptions: EventHubConsumerClient のパーティションの要求方法を調整するためのオプション。
  • userAgent : サービスへの接続プロパティとして渡される組み込みのユーザー エージェント文字列に追加する文字列。
  • webSocketOptions : Web ソケット経由の AMQP 接続のチャネリングを構成するためのオプション。
    • websocket : WebSocket 経由で接続を行う場合に AMQP 接続を作成するために使用される WebSocket コンストラクター。
    • webSocketConstructorOptions : WebSocket 経由で接続を行う場合に Websocket コンストラクターに渡すオプション。
  • retryOptions : クライアント/プロデューサー/コンシューマーに対するすべての操作の再試行オプション。
    • maxRetries : 再試行可能なエラーが発生した場合に操作を再試行できる回数。
    • maxRetryDelayInMs: 再試行間の最大遅延。 指数再試行を実行する場合にのみ適用されます。
    • mode: 列挙型で RetryMode 指定された、適用する再試行モード。 オプションは Exponential と Fixed です。 既定値は Fixed です。
    • retryDelayInMs: 次の試行を行う前に、ミリ秒単位で待機する時間。 が にExponential設定されている場合mode、再試行の間に指数関数的に増加する遅延を計算するために使用されます。 既定値: 30000 ミリ秒。
    • timeoutInMs: 操作がタイムアウトするまでの待機時間 (ミリ秒単位)。これにより、再試行が残っている場合に再試行がトリガーされます。 既定値: 60000 ミリ秒。

簡単な使用方法は です { "maxRetries": 4 }。

使用例:

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends
EventHubClientOptions

プロパティ

loadBalancingOptions

EventHubConsumerClient のパーティションの要求方法を調整するためのオプション。

継承されたプロパティ

customEndpointAddress

Event Hubs サービスに接続するときに使用するカスタム エンドポイント。 これは、ネットワークが標準のAzure Event Hubs エンドポイント アドレスへの接続は許可していないけれど、中継局経由での接続を許可している場合に便利です。

例: "https://my.custom.endpoint:100/"
identifier

クライアントを識別するために使用される一意の名前。 指定しない場合、GUID が識別子として使用されます
retryOptions

クライアント上のすべての操作に対して再試行ポリシーを構成するためのオプション。 たとえば、{ "maxRetries": 4 } または { "maxRetries": 4, "retryDelayInMs": 30000 } です。
userAgent

Event Hubs サービスに渡される組み込みのユーザー エージェント文字列に追加される値。
webSocketOptions

Web ソケット経由の AMQP 接続のチャネリングを構成するためのオプション。

プロパティの詳細

loadBalancingOptions

EventHubConsumerClient のパーティションの要求方法を調整するためのオプション。

loadBalancingOptions?: LoadBalancingOptions

プロパティ値

LoadBalancingOptions

継承されたプロパティの詳細

customEndpointAddress

Event Hubs サービスに接続するときに使用するカスタム エンドポイント。 これは、ネットワークが標準のAzure Event Hubs エンドポイント アドレスへの接続は許可していないけれど、中継局経由での接続を許可している場合に便利です。

例: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

プロパティ値

string

EventHubClientOptions.customEndpointAddressから継承

identifier

クライアントを識別するために使用される一意の名前。 指定しない場合、GUID が識別子として使用されます

identifier?: string

プロパティ値

string

EventHubClientOptions.identifierから継承

retryOptions

クライアント上のすべての操作に対して再試行ポリシーを構成するためのオプション。 たとえば、{ "maxRetries": 4 } または { "maxRetries": 4, "retryDelayInMs": 30000 } です。

retryOptions?: RetryOptions

プロパティ値

RetryOptions

EventHubClientOptions.retryOptionsから継承

userAgent

Event Hubs サービスに渡される組み込みのユーザー エージェント文字列に追加される値。

userAgent?: string

プロパティ値

string

EventHubClientOptions.userAgentから継承

webSocketOptions

Web ソケット経由の AMQP 接続のチャネリングを構成するためのオプション。

webSocketOptions?: WebSocketOptions

プロパティ値

WebSocketOptions

EventHubClientOptions.webSocketOptionsから継承