EventHubConsumerClient class

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

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。

を作成する方法は複数あります。 EventHubConsumerClient

  • Event Hub インスタンス用に作成された SAS ポリシーの接続文字列を使用します。
  • Event Hub 名前空間用に作成された SAS ポリシーの接続文字列と、Event Hub インスタンスの名前を使用します
  • 、 などの <yournamespace>.servicebus.windows.net完全な名前空間と資格情報オブジェクトを使用します。

必要に応じて、次の値を渡すこともできます。

  • 再試行ポリシーまたはプロキシ設定を構成するためのオプション バッグ。
  • クライアントがチェックポイントを読み取り、アプリケーションの再起動時にイベントの受信を再開する位置を決定するために使用されるチェックポイント ストア。 チェックポイント ストアは、アプリケーションの複数のインスタンスの負荷分散にもクライアントによって使用されます。

コンストラクター

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。

プロパティ

defaultConsumerGroupName

Event Hubs サービスの既定のコンシューマー グループの名前。
eventHubName

このクライアントが作成されるイベント ハブ インスタンスの名前。
fullyQualifiedNamespace

このクライアントが作成される Event Hub インスタンスの完全修飾名前空間。 これは、.servicebus.windows.net に似ている可能性があります。
identifier

この EventHubConsumerClient を識別するために使用される名前。 指定しない場合、または空の場合は、ランダムな一意のが生成されます。

メソッド

close()

Event Hub インスタンスへの AMQP 接続を閉じ、切断が完了したときに解決される Promise を返します。
getEventHubProperties(GetEventHubPropertiesOptions)

Event Hub ランタイム情報を提供します。
getPartitionIds(GetPartitionIdsOptions)

イベント ハブに関連付けられている各パーティションの ID を提供します。
getPartitionProperties(string, GetPartitionPropertiesOptions)

指定したパーティションの状態に関する情報を提供します。
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

1 つのパーティションからイベントをサブスクライブします。 返されたオブジェクトで close() を呼び出して、イベントの受信を停止します。

使用例:

const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
 partitionId,
 {
   processEvents: (events, context) => { console.log("Received event count: ", events.length) },
   processError: (err, context) => { console.log("Error: ", err) }
 },
 { startPosition: earliestEventPosition }
);
subscribe(SubscriptionEventHandlers, SubscribeOptions)

すべてのパーティションのイベントをサブスクライブします。

チェックポイント ストアが に EventHubConsumerClient 提供され、アプリケーションのインスタンスが複数ある場合、各インスタンスはパーティションのサブセットをサブスクライブし、それらの間で負荷が分散されます。

返されたオブジェクトで close() を呼び出して、イベントの受信を停止します。

使用例:

const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
 {
   processEvents: (events, context) => { console.log("Received event count: ", events.length) },
   processError: (err, context) => { console.log("Error: ", err) }
 },
 { startPosition: earliestEventPosition }
);

コンストラクターの詳細

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。

new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

パラメーター

consumerGroup

string

イベントを処理するコンシューマー グループの名前。

connectionString

string

Event Hub インスタンスへの接続に使用する接続文字列。 この接続文字列には、共有キーのプロパティとイベント ハブ パスが含まれている必要があります。 例: 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-event-hub-name'

checkpointStore
CheckpointStore

クライアントがチェックポイントを読み取り、アプリケーションの再起動時にイベントの受信を再開する位置を決定するために使用されるチェックポイント ストア。 また、アプリケーションの複数のインスタンスを負荷分散するために、クライアントによっても使用されます。

options
EventHubConsumerClientOptions

クライアントを構成するときに適用するオプションのセット。

  • retryOptions : クライアント上のすべての操作の再試行ポリシーを構成します。 たとえば、{ "maxRetries": 4 } または { "maxRetries": 4, "retryDelayInMs": 30000 } です。
  • webSocketOptions: Web ソケット経由の AMQP 接続のチャネリングを構成します。
  • userAgent : サービスに渡される組み込みのユーザー エージェント文字列に追加する文字列。

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。

new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)

パラメーター

consumerGroup

string

イベントを処理するコンシューマー グループの名前。

connectionString

string

Event Hub インスタンスへの接続に使用する接続文字列。 この接続文字列には、共有キーのプロパティとイベント ハブ パスが含まれている必要があります。 例: 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-event-hub-name'

options
EventHubConsumerClientOptions

クライアントを構成するときに適用するオプションのセット。

  • retryOptions : クライアント上のすべての操作の再試行ポリシーを構成します。 たとえば、{ "maxRetries": 4 } または { "maxRetries": 4, "retryDelayInMs": 30000 } です。
  • webSocketOptions: Web ソケット経由の AMQP 接続のチャネリングを構成します。
  • userAgent : サービスに渡される組み込みのユーザー エージェント文字列に追加する文字列。

EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

パラメーター

consumerGroup

string

イベントを処理するコンシューマー グループの名前。

connectionString

string

Event Hubs 名前空間への接続に使用する接続文字列。 共有キーのプロパティがこの接続文字列に含まれていることが予想されますが、イベント ハブのパスは含まれません。たとえば、'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;'.

eventHubName

string

クライアントの接続先となる特定のイベント ハブの名前。

checkpointStore
CheckpointStore

クライアントがチェックポイントを読み取り、アプリケーションの再起動時にイベントの受信を再開する位置を決定するために使用されるチェックポイント ストア。 また、アプリケーションの複数のインスタンスを負荷分散するために、クライアントによっても使用されます。

options
EventHubConsumerClientOptions

クライアントを構成するときに適用するオプションのセット。

  • retryOptions : クライアント上のすべての操作の再試行ポリシーを構成します。 たとえば、{ "maxRetries": 4 } または { "maxRetries": 4, "retryDelayInMs": 30000 } です。
  • webSocketOptions: Web ソケット経由の AMQP 接続のチャネリングを構成します。
  • userAgent : サービスに渡される組み込みのユーザー エージェント文字列に追加する文字列。

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)

パラメーター

consumerGroup

string

イベントを処理するコンシューマー グループの名前。

connectionString

string

Event Hubs 名前空間への接続に使用する接続文字列。 共有キーのプロパティがこの接続文字列に含まれていることが予想されますが、イベント ハブのパスは含まれません。たとえば、'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;'.

eventHubName

string

クライアントの接続先となる特定のイベント ハブの名前。

options
EventHubConsumerClientOptions

クライアントを構成するときに適用するオプションのセット。

  • retryOptions : クライアント上のすべての操作の再試行ポリシーを構成します。 たとえば、{ "maxRetries": 4 } または { "maxRetries": 4, "retryDelayInMs": 30000 } です。
  • webSocketOptions: Web ソケット経由の AMQP 接続のチャネリングを構成します。
  • userAgent : サービスに渡される組み込みのユーザー エージェント文字列に追加する文字列。

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。

new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

パラメーター

consumerGroup

string

イベントを処理するコンシューマー グループの名前。

fullyQualifiedNamespace

string

.servicebus.windows.net に似ている可能性が高い完全な名前空間

eventHubName

string

クライアントの接続先となる特定のイベント ハブの名前。

credential

TokenCredential | NamedKeyCredential | SASCredential

Azure Event Hubs サービスとの接続を認証するためのトークンを取得するためにクライアントによって使用される資格情報オブジェクト。 AAD 認証をサポートする資格情報の作成については、「@azure/ID」を参照してください。接続文字列を使用せずに と をAzureNamedKeyCredential渡SharedAccessKeyNameSharedAccessKeyす場合は、from @azure/core-auth を使用します。 これらのフィールドは、 name の フィールドと key フィールドにそれぞれ AzureNamedKeyCredentialマップされます。 接続文字列を使用せずに を AzureSASCredential 渡 SharedAccessSignature す場合は、from @azure/core-auth を使用します。 このフィールドは、 の にsignatureAzureSASCredentialマップされます。

checkpointStore
CheckpointStore

クライアントがチェックポイントを読み取り、アプリケーションの再起動時にイベントの受信を再開する位置を決定するために使用されるチェックポイント ストア。 また、アプリケーションの複数のインスタンスを負荷分散するために、クライアントによっても使用されます。

options
EventHubConsumerClientOptions

クライアントを構成するときに適用するオプションのセット。

  • retryOptions : クライアント上のすべての操作の再試行ポリシーを構成します。 たとえば、{ "maxRetries": 4 } または { "maxRetries": 4, "retryDelayInMs": 30000 } です。
  • webSocketOptions: Web ソケット経由の AMQP 接続のチャネリングを構成します。
  • userAgent : サービスに渡される組み込みのユーザー エージェント文字列に追加する文字列。

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

クラスは EventHubConsumerClient 、イベント ハブからのイベントを使用するために使用されます。 parmeter を options 使用して、再試行ポリシーまたはプロキシ設定を構成します。

new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)

パラメーター

consumerGroup

string

イベントを処理するコンシューマー グループの名前。

fullyQualifiedNamespace

string

.servicebus.windows.net に似ている可能性が高い完全な名前空間

eventHubName

string

クライアントの接続先となる特定のイベント ハブの名前。

credential

TokenCredential | NamedKeyCredential | SASCredential

Azure Event Hubs サービスとの接続を認証するためのトークンを取得するためにクライアントによって使用される資格情報オブジェクト。 AAD 認証をサポートする資格情報の作成については、「@azure/ID」を参照してください。接続文字列を使用せずに と をAzureNamedKeyCredential渡SharedAccessKeyNameSharedAccessKeyす場合は、from @azure/core-auth を使用します。 これらのフィールドは、 name の フィールドと key フィールドにそれぞれ AzureNamedKeyCredentialマップされます。 接続文字列を使用せずに を AzureSASCredential 渡 SharedAccessSignature す場合は、from @azure/core-auth を使用します。 このフィールドは、 の にsignatureAzureSASCredentialマップされます。

options
EventHubConsumerClientOptions

クライアントを構成するときに適用するオプションのセット。

  • retryOptions : クライアント上のすべての操作の再試行ポリシーを構成します。 たとえば、{ "maxRetries": 4 } または { "maxRetries": 4, "retryDelayInMs": 30000 } です。
  • webSocketOptions: Web ソケット経由の AMQP 接続のチャネリングを構成します。
  • userAgent : サービスに渡される組み込みのユーザー エージェント文字列に追加する文字列。

プロパティの詳細

defaultConsumerGroupName

Event Hubs サービスの既定のコンシューマー グループの名前。

static defaultConsumerGroupName: string

プロパティ値

string

eventHubName

このクライアントが作成されるイベント ハブ インスタンスの名前。

string eventHubName

プロパティ値

string

fullyQualifiedNamespace

このクライアントが作成される Event Hub インスタンスの完全修飾名前空間。 これは、.servicebus.windows.net に似ている可能性があります。

string fullyQualifiedNamespace

プロパティ値

string

identifier

この EventHubConsumerClient を識別するために使用される名前。 指定しない場合、または空の場合は、ランダムな一意のが生成されます。

identifier: string

プロパティ値

string

メソッドの詳細

close()

Event Hub インスタンスへの AMQP 接続を閉じ、切断が完了したときに解決される Promise を返します。

function close(): Promise<void>

戻り値

Promise<void>

Promise

getEventHubProperties(GetEventHubPropertiesOptions)

Event Hub ランタイム情報を提供します。

function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>

パラメーター

options
GetEventHubPropertiesOptions

操作呼び出しに適用するオプションのセット。

戻り値

Promise<EventHubProperties>

Event Hub インスタンスに関する情報で解決される promise。

getPartitionIds(GetPartitionIdsOptions)

イベント ハブに関連付けられている各パーティションの ID を提供します。

function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>

パラメーター

options
GetPartitionIdsOptions

操作呼び出しに適用するオプションのセット。

戻り値

Promise<string[]>

イベント ハブに関連付けられている各パーティションの ID を表す文字列の配列で解決される promise。

getPartitionProperties(string, GetPartitionPropertiesOptions)

指定したパーティションの状態に関する情報を提供します。

function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>

パラメーター

partitionId

string

情報が必要なパーティションの ID。

options
GetPartitionPropertiesOptions

操作呼び出しに適用するオプションのセット。

戻り値

Promise<PartitionProperties>

パーティション の状態に関する情報で解決される promise。

subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

1 つのパーティションからイベントをサブスクライブします。 返されたオブジェクトで close() を呼び出して、イベントの受信を停止します。

使用例:

const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
 partitionId,
 {
   processEvents: (events, context) => { console.log("Received event count: ", events.length) },
   processError: (err, context) => { console.log("Error: ", err) }
 },
 { startPosition: earliestEventPosition }
);

function subscribe(partitionId: string, handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription

パラメーター

partitionId

string

サブスクライブするパーティションの ID。

handlers
SubscriptionEventHandlers

サブスクリプションのライフサイクルのハンドラー - パーティションのサブスクリプションの初期化、イベントの受信、エラーの処理、パーティションへのサブスクリプションの終了。

options
SubscribeOptions

イベントの受信方法を構成します。 最も一般的なものは maxBatchSize 、 であり、 maxWaitTimeInSeconds イベントを受信するために提供されるハンドラーへのイベントのフローと開始位置を制御します。 たとえば、{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } } のように指定します。

戻り値

Subscription

subscribe(SubscriptionEventHandlers, SubscribeOptions)

すべてのパーティションのイベントをサブスクライブします。

チェックポイント ストアが に EventHubConsumerClient 提供され、アプリケーションのインスタンスが複数ある場合、各インスタンスはパーティションのサブセットをサブスクライブし、それらの間で負荷が分散されます。

返されたオブジェクトで close() を呼び出して、イベントの受信を停止します。

使用例:

const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
 {
   processEvents: (events, context) => { console.log("Received event count: ", events.length) },
   processError: (err, context) => { console.log("Error: ", err) }
 },
 { startPosition: earliestEventPosition }
);

function subscribe(handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription

パラメーター

handlers
SubscriptionEventHandlers

サブスクリプションのライフサイクルのハンドラー - パーティションごとのサブスクリプションの初期化、イベントの受信、エラーの処理、パーティションごとのサブスクリプションの終了。

options
SubscribeOptions

イベントの受信方法を構成します。 最も一般的なものは maxBatchSize 、 であり、 maxWaitTimeInSeconds イベントを受信するために提供されるハンドラーへのイベントのフローと開始位置を制御します。 たとえば、{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } } のように指定します。

戻り値

Subscription