@azure/event-hubs package

クラス

EventHubBufferedProducerClient	EventHubBufferedProducerClientは、特定のイベント ハブにイベントを発行するために使用されます。 EventHubBufferedProducerClient はすぐにはイベントを発行しません。 代わりに、イベントはバッファー処理されるため、バッチがいっぱいになった場合や、新しいイベントがエンキューされていない状態で maxWaitTimeInMs が経過したときに、イベントを効率的にバッチ処理して発行できます。 イベントがエンキューされるときに指定されたオプションに応じて、自動的にパーティションに割り当てられるか、指定されたパーティション キーに従ってグループ化されるか、または特定の要求されたパーティションが割り当てられる場合があります。 このモデルは、イベントが発行されるタイミングに関して、非確定的なタイミングを犠牲にして、バッチ管理の負担を呼び出し元からシフトすることを目的としています。 考慮すべきその他のトレードオフもあります。 アプリケーションがクラッシュした場合、バッファー内のイベントは発行されません。 データ損失を防ぐために、呼び出し元は、onSendEventsSuccessHandler ハンドラーと onSendEventsErrorHandler ハンドラーを使用して発行の進行状況を追跡することをお勧めします。 パーティション キーを指定するイベントには、他のプロデューサーと同じキーを使用するイベントとは異なるパーティションが割り当てられる場合があります。 万が一、パーティションが一時的に使用できなくなった場合、EventHubBufferedProducerClient は他のプロデューサーよりも回復に時間がかかる場合があります。 決定論的な結果でイベントをすぐに公開することが重要なシナリオでは、パーティション キーが他のパブリッシャーと一致するパーティションに割り当てられているか、可用性の最大化が要件である場合は、EventHubProducerClient を使用することをお勧めします。
EventHubConsumerClient	EventHubConsumerClient クラスは、イベント ハブからのイベントを使用するために使用されます。 EventHubConsumerClient を作成するには複数の方法があります Event Hub インスタンス用に作成された SAS ポリシーの接続文字列を使用します。 Event Hub 名前空間用に作成された SAS ポリシーの接続文字列と、イベント ハブ インスタンスの名前を使用する <yournamespace>.servicebus.windows.netなどの完全な名前空間と資格情報オブジェクトを使用します。 必要に応じて、次のコードを渡すこともできます。 再試行ポリシーまたはプロキシ設定を構成するためのオプション バッグ。 クライアントがチェックポイントを読み取り、アプリケーションの再起動時にイベントの受信を再開する位置を決定するために使用されるチェックポイント ストア。 チェックポイント ストアは、アプリケーションの複数のインスタンスの負荷分散にもクライアントによって使用されます。
EventHubProducerClient	EventHubProducerClient クラスは、イベント ハブにイベントを送信するために使用されます。 EventHubProducerClient を作成するには複数の方法があります Event Hub インスタンス用に作成された SAS ポリシーの接続文字列を使用します。 Event Hub 名前空間用に作成された SAS ポリシーの接続文字列と、イベント ハブ インスタンスの名前を使用する <yournamespace>.servicebus.windows.netなどの完全な名前空間と資格情報オブジェクトを使用します。 必要に応じて、オプション バッグを渡して再試行ポリシーまたはプロキシ設定を構成することもできます。
MessagingError	メッセージング エラーの基本クラスについて説明します。

インターフェイス

BufferedCloseOptions	EventHubBufferedProducerClientで close メソッドを構成するオプション。
BufferedFlushOptions	EventHubBufferedProducerClientで flush メソッドを構成するオプション。
Checkpoint	チェックポイントは、Event Hub インスタンス内のコンシューマー グループの特定のパーティションからユーザーが最後に正常に処理したイベントを表します。 PartitionProcessor クラスの updateCheckpoint() メソッドがユーザーによって呼び出されると、Checkpoint が内部的に作成されます。 その後、EventProcessorの作成時にユーザーが選択した CheckpointManager によって実装されたストレージ ソリューションに格納されます。 ユーザーが Checkpoint を直接操作することは想定されません。 このインターフェイスは、EventProcessor と CheckpointManagerの内部動作をサポートするために存在します。
CheckpointStore	チェックポイント ストアは、イベント ハブ インスタンスの特定のコンシューマー グループ内の各パーティションのパーティション所有権情報とチェックポイントの詳細を格納および取得します。 ユーザーは、CheckpointStoreを実装するためのものではありません。 ユーザーは、クライアントをインスタンス化するときに、このインターフェイスの既存の実装を選択し、インスタンス化し、EventHubConsumerClient クラス コンストラクターに渡す必要があります。 ユーザーはチェックポイント ストアでメソッドを使用することは想定されていません。これらはクライアントによって内部的に使用されます。 CheckpointStore の実装は、プレフィックス @azure/eventhub-checkpointstore-を持つパッケージを検索することで npm で見つけることができます。
CreateBatchOptions	EventHubProducerClientで createBatch メソッドを構成するオプション。 partitionKey: パーティション割り当てを生成するためにハッシュされる値。 maxSizeInBytes: バッチのサイズの上限。 abortSignal: 送信操作を取り消す要求を通知します。 使用例: { partitionKey: 'foo', maxSizeInBytes: 1024 * 1024 // 1 MB }
EnqueueEventOptions	EventHubBufferedProducerClientで enqueueEvents メソッドを構成するオプション。
EventData	イベント ハブに送信されるデータを記述するインターフェイス。 これは、EventHubProducerClientを使用するときに送信するオブジェクトを作成するときに参照として使用します。 たとえば、{ body: "your-data" } や { body: "your-data", properties: { propertyName: "property value" } }
EventDataAdapterParameters	イベント データ アダプターを作成する createEventDataAdapter 関数のパラメーター。
EventDataBatch	イベント ハブにイベントを送信するために使用できるイベントのバッチを表すインターフェイス。 バッチを作成するには、EventHubProducerClientで createBatch() メソッドを使用します。 バッチを送信するには、同じクライアントで sendBatch() メソッドを使用します。 バッチを入力するには、バッチ自体に対して tryAdd() メソッドを使用します。
EventHubBufferedProducerClientOptions	EventHubBufferedProducerClientの作成時に指定できるオプションについて説明します。
EventHubClientOptions	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 } }
EventHubConnectionStringProperties	イベント ハブ接続文字列を構成するプロパティのセット。
EventHubConsumerClientOptions	EventHubConsumerClient の作成時に指定できるオプションについて説明します。 loadBalancingOptions: EventHubConsumerClient がパーティションを要求する方法を調整するためのオプション。 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 } }
EventHubProperties	イベント ハブのランタイム情報について説明します。
EventPosition	イベント ハブ パーティション内のイベントの位置を表します。通常、イベントの受信を開始するパーティション内の位置を指定する EventHubConsumerClient で subscribe() メソッドを呼び出すときに使用されます。 ストリームの開始または終了を表す EventPosition を取得するには、それぞれ earliestEventPosition 定数と latestEventPosition 定数を使用します。
GetEventHubPropertiesOptions	getEventHubPropertiesの動作を構成するためのオプションのセット。 abortSignal: 操作を取り消す要求を通知する AbortSignalLike インターフェイスの実装。 parentSpan: この操作の呼び出し中に作成されたスパンの parent として使用する Span または SpanContext。
GetPartitionIdsOptions	getPartitionIdsの動作を構成するためのオプションのセット。 abortSignal: 操作を取り消す要求を通知する AbortSignalLike インターフェイスの実装。 parentSpan: この操作の呼び出し中に作成されたスパンの parent として使用する Span または SpanContext。
GetPartitionPropertiesOptions	getPartitionPropertiesの動作を構成するためのオプションのセット。 abortSignal: 操作を取り消す要求を通知する AbortSignalLike インターフェイスの実装。 parentSpan: この操作の呼び出し中に作成されたスパンの parent として使用する Span または SpanContext。
LastEnqueuedEventProperties	イベントが Event Hubs サービスから受信されるとコンシューマーによって観察される、パーティションの最後にエンキューされたイベントに関する一連の情報
LoadBalancingOptions	負荷分散設定を構成するためのオプション バッグ。
OnSendEventsErrorContext	イベント ハブに正常に送信されなかったイベント、割り当てられたパーティション、および送信中に発生したエラーが含まれます。
OnSendEventsSuccessContext	イベント ハブに正常に送信されたイベントと、割り当てられたパーティションが含まれます。
OperationOptions	トレースと abortSignal を構成するためのオプション。
PartitionContext	SubscriptionEventHandlersの一部である各関数に渡されるコンテキストを記述するインターフェイス。 これらの関数のいずれかを実装する場合は、コンテキスト オブジェクトを使用して、パーティションに関する情報とチェックポイント機能を取得します。
PartitionOwnership	イベント ハブ インスタンスのコンシューマー グループから特定のパーティションの処理を所有する EventProcessor のインスタンスの詳細を表すインターフェイス。 注意: これは EventProcessor によって内部的に使用され、ユーザーが直接作成する必要はありません。
PartitionProperties	EventHub パーティションのランタイム情報について説明します。
ReceivedEventData	Event Hub から受信したイベントの構造を記述するインターフェイス。 これは、EventHubConsumerClientを使用するときにイベント ハブから受信したイベントを処理する processEvents 関数を作成するときに参照として使用します。
RetryOptions	モード、再試行回数、再試行間隔などを決定する再試行ポリシー オプション。
SendBatchOptions	イベントの配列を送信するときに EventHubProducerClient に sendBatch メソッドを構成するオプション。 partitionId が設定されている場合は、partitionKey を設定しないでください。その逆も同様です。 partitionId: このバッチが送信されるパーティション。 partitionKey: パーティション割り当てを生成するためにハッシュされる値。 abortSignal: 送信操作を取り消すために使用されるシグナル。
SubscribeOptions	EventHubConsumerClientで subscribe メソッドを構成するオプション。 たとえば、{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Subscription	EventHubConsumerClientの subscribe() メソッドによって返されるオブジェクトを記述するインターフェイス。
SubscriptionEventHandlers	イベント ハブからイベントを受信するために subscribe() メソッドが呼び出されたときに EventHubConsumerClient によって呼び出されるユーザーによって実装される関数を記述するインターフェイス。
TokenCredential	認証トークンを提供できる資格情報を表します。
TryAddOptions	EventDataBatch クラスの tryAdd メソッドの動作を構成するオプション。
WebSocketImpl	WebSocket コンストラクターの必要な形状について説明します。
WebSocketOptions	Web ソケット経由の AMQP 接続のチャネリングを構成するオプション。

型エイリアス

ProcessCloseHandler	パーティションからイベントを受信するために停止した直後に EventHubConsumerClient によって呼び出されたユーザー指定関数のシグネチャ。
ProcessErrorHandler	イベントの受信時または subscribe() メソッドに渡されたユーザー指定関数の実行時に発生するエラーに対して、EventHubConsumerClient によって呼び出されたユーザー指定関数のシグネチャ。
ProcessEventsHandler	一連のイベントを受信したときに EventHubConsumerClient によって呼び出されたユーザー指定関数のシグネチャ。
ProcessInitializeHandler	パーティションからのイベントの受信を開始する直前に、EventHubConsumerClient によって呼び出されたユーザー指定関数のシグネチャ。

列挙型

CloseReason	EventHubConsumerClient がイベント ハブのコンシューマー グループ内のパーティションからのイベントの処理を停止するさまざまな理由を表す列挙型。
RetryMode	再試行モードの種類について説明します

関数

createEventDataAdapter(EventDataAdapterParameters)	イベント データ アダプターを構築する関数。 そのアダプターを @azure/schema-registry-avro と共に使用して、イベント データ内の本文をエンコードおよびデコードできます。
parseEventHubConnectionString(string)	指定された接続文字列を、Azure Event Hubs に適用できるさまざまなプロパティに解析します。 このプロパティは、EventHubProducerClient または EventHubConsumerClient を構築するのに役立ちます。

関数の詳細

createEventDataAdapter(EventDataAdapterParameters)

イベント データ アダプターを構築する関数。 そのアダプターを @azure/schema-registry-avro と共に使用して、イベント データ内の本文をエンコードおよびデコードできます。

function createEventDataAdapter(params?: EventDataAdapterParameters): MessageAdapter<EventData>

パラメーター

params

EventDataAdapterParameters

イベント データを作成するためのパラメーター

戻り値

MessageAdapter<EventData>

イベント データを生成および使用できるイベント データ アダプター

parseEventHubConnectionString(string)

指定された接続文字列を、Azure Event Hubs に適用できるさまざまなプロパティに解析します。 このプロパティは、EventHubProducerClient または EventHubConsumerClient を構築するのに役立ちます。

function parseEventHubConnectionString(connectionString: string): Readonly<EventHubConnectionStringProperties>

パラメーター

connectionString

string

Event Hubs 名前空間用に作成された共有アクセス ポリシーに関連付けられている接続文字列。

戻り値

Readonly<EventHubConnectionStringProperties>