Delen via


EventHubConsumerClient class

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken.

Er zijn meerdere manieren om een EventHubConsumerClient

  • Gebruik de connection string van het SAS-beleid dat is gemaakt voor uw Event Hub-exemplaar.
  • Gebruik de connection string van het SAS-beleid dat is gemaakt voor uw Event Hub-naamruimte en de naam van het Event Hub-exemplaar
  • Gebruik de volledige naamruimte, zoals <yournamespace>.servicebus.windows.net, en een referentieobject.

U kunt eventueel ook het volgende doorgeven:

  • Een optiesverzameling voor het configureren van het beleid voor opnieuw proberen of proxy-instellingen.
  • Een controlepuntarchief dat door de client wordt gebruikt om controlepunten te lezen om de positie te bepalen van waaruit het ontvangen van gebeurtenissen moet hervatten wanneer uw toepassing opnieuw wordt gestart. Het controlepuntarchief wordt ook door de client gebruikt om meerdere exemplaren van uw toepassing te verdelen.

Constructors

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

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

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

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

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

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

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

Eigenschappen

defaultConsumerGroupName

De naam van de standaardconsumentengroep in de Event Hubs-service.

eventHubName

De naam van het Event Hub-exemplaar waarvoor deze client is gemaakt.

fullyQualifiedNamespace

De volledig gekwalificeerde naamruimte van het Event Hub-exemplaar waarvoor deze client is gemaakt. Dit is waarschijnlijk vergelijkbaar met .servicebus.windows.net.

identifier

De naam die wordt gebruikt om deze EventHubConsumerClient te identificeren. Als dit niet is opgegeven of leeg is, wordt er een willekeurige unieke gegenereerd.

Methoden

close()

Sluit de AMQP-verbinding met het Event Hub-exemplaar en retourneert een belofte die wordt opgelost wanneer de verbinding is verbroken.

getEventHubProperties(GetEventHubPropertiesOptions)

Biedt informatie over de Event Hub-runtime.

getPartitionIds(GetPartitionIdsOptions)

Geeft de id op voor elke partitie die is gekoppeld aan de Event Hub.

getPartitionProperties(string, GetPartitionPropertiesOptions)

Biedt informatie over de status van de opgegeven partitie.

subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

Abonneren op gebeurtenissen van één partitie. Roep close() aan op het geretourneerde object om het ontvangen van gebeurtenissen te stoppen.

Gebruiksvoorbeeld:

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)

Abonneren op gebeurtenissen van alle partities.

Als het controlepuntarchief wordt geleverd aan de EventHubConsumerClient en er meerdere exemplaren van uw toepassing zijn, wordt elk exemplaar geabonneerd op een subset van de partities, zodat de belasting over de partities wordt verdeeld.

Roep close() aan op het geretourneerde object om het ontvangen van gebeurtenissen te stoppen.

Gebruiksvoorbeeld:

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 }
);

Constructordetails

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

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

Parameters

consumerGroup

string

De naam van de consumentengroep van waaruit u gebeurtenissen wilt verwerken.

connectionString

string

De connection string die moet worden gebruikt om verbinding te maken met het Event Hub-exemplaar. Naar verwachting zijn de eigenschappen van de gedeelde sleutel en het Event Hub-pad opgenomen in deze connection string. bijvoorbeeld 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

checkpointStore
CheckpointStore

Een controlepuntarchief dat door de client wordt gebruikt om controlepunten te lezen om de positie te bepalen van waaruit het ontvangen van gebeurtenissen moet hervatten wanneer uw toepassing opnieuw wordt gestart. Het wordt ook gebruikt door de client om meerdere exemplaren van uw toepassing te verdelen.

options
EventHubConsumerClientOptions

Een reeks opties die moeten worden toegepast bij het configureren van de client.

  • retryOptions : Hiermee configureert u het beleid voor opnieuw proberen voor alle bewerkingen op de client. Bijvoorbeeld { "maxRetries": 4 } of { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Hiermee configureert u de channeling van de AMQP-verbinding via websockets.
  • userAgent : Een tekenreeks die moet worden toegevoegd aan de ingebouwde tekenreeks van de gebruikersagent die wordt doorgegeven aan de service.

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

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

Parameters

consumerGroup

string

De naam van de consumentengroep van waaruit u gebeurtenissen wilt verwerken.

connectionString

string

De connection string die moet worden gebruikt om verbinding te maken met het Event Hub-exemplaar. Naar verwachting zijn de eigenschappen van de gedeelde sleutel en het Event Hub-pad opgenomen in deze connection string. bijvoorbeeld 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

options
EventHubConsumerClientOptions

Een reeks opties die moeten worden toegepast bij het configureren van de client.

  • retryOptions : Hiermee configureert u het beleid voor opnieuw proberen voor alle bewerkingen op de client. Bijvoorbeeld { "maxRetries": 4 } of { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Hiermee configureert u de channeling van de AMQP-verbinding via websockets.
  • userAgent : Een tekenreeks die moet worden toegevoegd aan de ingebouwde tekenreeks van de gebruikersagent die wordt doorgegeven aan de service.

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

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

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

Parameters

consumerGroup

string

De naam van de consumentengroep van waaruit u gebeurtenissen wilt verwerken.

connectionString

string

De connection string om verbinding te maken met de Event Hubs-naamruimte. De gedeelde sleuteleigenschappen worden verwacht in deze connection string, maar niet in het Event Hub-pad, bijvoorbeeld 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

De naam van de specifieke Event Hub waarmee de client verbinding moet maken.

checkpointStore
CheckpointStore

Een controlepuntarchief dat door de client wordt gebruikt om controlepunten te lezen om de positie te bepalen van waaruit het ontvangen van gebeurtenissen moet hervatten wanneer uw toepassing opnieuw wordt gestart. Het wordt ook gebruikt door de client om meerdere exemplaren van uw toepassing te verdelen.

options
EventHubConsumerClientOptions

Een reeks opties die moeten worden toegepast bij het configureren van de client.

  • retryOptions : Hiermee configureert u het beleid voor opnieuw proberen voor alle bewerkingen op de client. Bijvoorbeeld { "maxRetries": 4 } of { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Hiermee configureert u de channeling van de AMQP-verbinding via websockets.
  • userAgent : Een tekenreeks die moet worden toegevoegd aan de ingebouwde tekenreeks van de gebruikersagent die wordt doorgegeven aan de service.

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

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

Parameters

consumerGroup

string

De naam van de consumentengroep van waaruit u gebeurtenissen wilt verwerken.

connectionString

string

De connection string om verbinding te maken met de Event Hubs-naamruimte. De gedeelde sleuteleigenschappen worden verwacht in deze connection string, maar niet in het Event Hub-pad, bijvoorbeeld 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

De naam van de specifieke Event Hub waarmee de client verbinding moet maken.

options
EventHubConsumerClientOptions

Een reeks opties die moeten worden toegepast bij het configureren van de client.

  • retryOptions : Hiermee configureert u het beleid voor opnieuw proberen voor alle bewerkingen op de client. Bijvoorbeeld { "maxRetries": 4 } of { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Hiermee configureert u de channeling van de AMQP-verbinding via websockets.
  • userAgent : Een tekenreeks die moet worden toegevoegd aan de ingebouwde tekenreeks van de gebruikersagent die wordt doorgegeven aan de service.

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

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

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

Parameters

consumerGroup

string

De naam van de consumentengroep van waaruit u gebeurtenissen wilt verwerken.

fullyQualifiedNamespace

string

De volledige naamruimte die waarschijnlijk vergelijkbaar is met .servicebus.windows.net

eventHubName

string

De naam van de specifieke Event Hub waarmee de client verbinding moet maken.

credential

TokenCredential | NamedKeyCredential | SASCredential

Een referentieobject dat door de client wordt gebruikt om het token op te halen om de verbinding met de Azure Event Hubs-service te verifiëren. Zie @azure/identity voor het maken van referenties die ondersteuning bieden voor AAD-verificatie. Gebruik de AzureNamedKeyCredential van @azure/core-auth als u een SharedAccessKeyName en SharedAccessKey wilt doorgeven zonder een connection string te gebruiken. Deze velden worden respectievelijk toegewezen aan het name veld en key in AzureNamedKeyCredential. Gebruik de AzureSASCredential van @azure/core-auth als u een SharedAccessSignature wilt doorgeven zonder een connection string te gebruiken. Dit veld wordt toegewezen aan signature in AzureSASCredential.

checkpointStore
CheckpointStore

Een controlepuntarchief dat door de client wordt gebruikt om controlepunten te lezen om de positie te bepalen van waaruit het ontvangen van gebeurtenissen moet hervatten wanneer uw toepassing opnieuw wordt gestart. Het wordt ook gebruikt door de client om meerdere exemplaren van uw toepassing te verdelen.

options
EventHubConsumerClientOptions

Een reeks opties die moeten worden toegepast bij het configureren van de client.

  • retryOptions : Hiermee configureert u het beleid voor opnieuw proberen voor alle bewerkingen op de client. Bijvoorbeeld { "maxRetries": 4 } of { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Hiermee configureert u de channeling van de AMQP-verbinding via websockets.
  • userAgent : Een tekenreeks die moet worden toegevoegd aan de ingebouwde tekenreeks van de gebruikersagent die wordt doorgegeven aan de service.

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

De EventHubConsumerClient klasse wordt gebruikt om gebeurtenissen van een Event Hub te gebruiken. Gebruik de options parmeter om beleid voor opnieuw proberen of proxy-instellingen te configureren.

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

Parameters

consumerGroup

string

De naam van de consumentengroep van waaruit u gebeurtenissen wilt verwerken.

fullyQualifiedNamespace

string

De volledige naamruimte die waarschijnlijk vergelijkbaar is met .servicebus.windows.net

eventHubName

string

De naam van de specifieke Event Hub waarmee de client verbinding moet maken.

credential

TokenCredential | NamedKeyCredential | SASCredential

Een referentieobject dat door de client wordt gebruikt om het token op te halen om de verbinding met de Azure Event Hubs-service te verifiëren. Zie @azure/identity voor het maken van referenties die ondersteuning bieden voor AAD-verificatie. Gebruik de AzureNamedKeyCredential van @azure/core-auth als u een SharedAccessKeyName en SharedAccessKey wilt doorgeven zonder een connection string te gebruiken. Deze velden worden respectievelijk toegewezen aan het name veld en key in AzureNamedKeyCredential. Gebruik de AzureSASCredential van @azure/core-auth als u een SharedAccessSignature wilt doorgeven zonder een connection string te gebruiken. Dit veld wordt toegewezen aan signature in AzureSASCredential.

options
EventHubConsumerClientOptions

Een reeks opties die moeten worden toegepast bij het configureren van de client.

  • retryOptions : Hiermee configureert u het beleid voor opnieuw proberen voor alle bewerkingen op de client. Bijvoorbeeld { "maxRetries": 4 } of { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Hiermee configureert u de channeling van de AMQP-verbinding via websockets.
  • userAgent : Een tekenreeks die moet worden toegevoegd aan de ingebouwde tekenreeks van de gebruikersagent die wordt doorgegeven aan de service.

Eigenschapdetails

defaultConsumerGroupName

De naam van de standaardconsumentengroep in de Event Hubs-service.

static defaultConsumerGroupName: string

Waarde van eigenschap

string

eventHubName

De naam van het Event Hub-exemplaar waarvoor deze client is gemaakt.

string eventHubName

Waarde van eigenschap

string

fullyQualifiedNamespace

De volledig gekwalificeerde naamruimte van het Event Hub-exemplaar waarvoor deze client is gemaakt. Dit is waarschijnlijk vergelijkbaar met .servicebus.windows.net.

string fullyQualifiedNamespace

Waarde van eigenschap

string

identifier

De naam die wordt gebruikt om deze EventHubConsumerClient te identificeren. Als dit niet is opgegeven of leeg is, wordt er een willekeurige unieke gegenereerd.

identifier: string

Waarde van eigenschap

string

Methodedetails

close()

Sluit de AMQP-verbinding met het Event Hub-exemplaar en retourneert een belofte die wordt opgelost wanneer de verbinding is verbroken.

function close(): Promise<void>

Retouren

Promise<void>

Belofte

getEventHubProperties(GetEventHubPropertiesOptions)

Biedt informatie over de Event Hub-runtime.

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

Parameters

options
GetEventHubPropertiesOptions

De set opties die moeten worden toegepast op de bewerkingsoproep.

Retouren

Een belofte die wordt omgezet met informatie over het Event Hub-exemplaar.

getPartitionIds(GetPartitionIdsOptions)

Geeft de id op voor elke partitie die is gekoppeld aan de Event Hub.

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

Parameters

options
GetPartitionIdsOptions

De set opties die moeten worden toegepast op de bewerkingsoproep.

Retouren

Promise<string[]>

Een belofte die wordt omgezet met een matrix van tekenreeksen die de id vertegenwoordigen voor elke partitie die is gekoppeld aan de Event Hub.

getPartitionProperties(string, GetPartitionPropertiesOptions)

Biedt informatie over de status van de opgegeven partitie.

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

Parameters

partitionId

string

De id van de partitie waarvoor informatie is vereist.

options
GetPartitionPropertiesOptions

De set opties die moeten worden toegepast op de bewerkingsoproep.

Retouren

Een belofte die wordt omgezet met informatie over de status van de partitie .

subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

Abonneren op gebeurtenissen van één partitie. Roep close() aan op het geretourneerde object om het ontvangen van gebeurtenissen te stoppen.

Gebruiksvoorbeeld:

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

Parameters

partitionId

string

De id van de partitie waarop u zich wilt abonneren.

handlers
SubscriptionEventHandlers

Handlers voor de levenscyclus van het abonnement: initialisatie van het abonnement van de partitie, het ontvangen van gebeurtenissen, het verwerken van fouten en het sluiten van een abonnement op de partitie.

options
SubscribeOptions

Hiermee configureert u de manier waarop gebeurtenissen worden ontvangen. De meest voorkomende zijn maxBatchSize en maxWaitTimeInSeconds die de stroom van gebeurtenissen naar de handler regelen die is opgegeven om gebeurtenissen te ontvangen, evenals de beginpositie. Bijvoorbeeld: { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Retouren

subscribe(SubscriptionEventHandlers, SubscribeOptions)

Abonneren op gebeurtenissen van alle partities.

Als het controlepuntarchief wordt geleverd aan de EventHubConsumerClient en er meerdere exemplaren van uw toepassing zijn, wordt elk exemplaar geabonneerd op een subset van de partities, zodat de belasting over de partities wordt verdeeld.

Roep close() aan op het geretourneerde object om het ontvangen van gebeurtenissen te stoppen.

Gebruiksvoorbeeld:

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

Parameters

handlers
SubscriptionEventHandlers

Handlers voor de levenscyclus van het abonnement: abonnementsinitialisatie per partitie, ontvangen van gebeurtenissen, afhandelen van fouten en het sluiten van een abonnement per partitie.

options
SubscribeOptions

Hiermee configureert u de manier waarop gebeurtenissen worden ontvangen. De meest voorkomende zijn maxBatchSize en maxWaitTimeInSeconds die de stroom van gebeurtenissen naar de handler regelen die is opgegeven om gebeurtenissen te ontvangen, evenals de beginpositie. Bijvoorbeeld: { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Retouren