EventHubConsumerClient class
Die EventHubConsumerClient -Klasse wird verwendet, um Ereignisse von einem Event Hub zu nutzen.
Es gibt mehrere Möglichkeiten, eine EventHubConsumerClient
- Verwenden Sie die Verbindungszeichenfolge aus der SAS-Richtlinie, die für Ihre Event Hub-instance erstellt wurde.
- Verwenden Sie die Verbindungszeichenfolge aus der SAS-Richtlinie, die für Ihren Event Hub-Namespace erstellt wurde, und den Namen des Event Hub-instance
- Verwenden Sie den vollständigen Namespace wie
<yournamespace>.servicebus.windows.net, und ein Anmeldeinformationsobjekt.
Optional können Sie auch Folgendes übergeben:
- Ein Optionsbehälter zum Konfigurieren der Wiederholungsrichtlinie oder Proxyeinstellungen.
- Ein Prüfpunktspeicher, der vom Client zum Lesen von Prüfpunkten verwendet wird, um die Position zu bestimmen, von der aus die Empfangen von Ereignissen fortgesetzt werden soll, wenn Ihre Anwendung neu gestartet wird. Der Prüfpunktspeicher wird auch vom Client verwendet, um einen Lastenausgleich für mehrere Instanzen Ihrer Anwendung zu erstellen.
Konstruktoren
| Event |
Die |
| Event |
Die |
| Event |
Die |
| Event |
Die |
| Event |
Die |
| Event |
Die |
Eigenschaften
| default |
Der Name der Standardconsumergruppe im Event Hubs-Dienst. |
| event |
Der Name des Event Hub-instance, für den dieser Client erstellt wird. |
| fully |
Der vollqualifizierte Namespace des Event Hub-instance, für den dieser Client erstellt wird. Dies ist wahrscheinlich ähnlich wie servicebus.windows.net. |
| identifier | Der Name, der verwendet wird, um diesen EventHubConsumerClient zu identifizieren. Wenn nicht angegeben oder leer, wird eine zufällige eindeutige generiert. |
Methoden
| close() | Schließt die AMQP-Verbindung mit dem Event Hub-instance und gibt eine Zusage zurück, die aufgelöst wird, wenn die Trennung abgeschlossen ist. |
| get |
Stellt die Event Hub-Laufzeitinformationen bereit. |
| get |
Stellt die ID für jede Partition bereit, die dem Event Hub zugeordnet ist. |
| get |
Stellt Informationen zum Status der angegebenen Partition bereit. |
| subscribe(string, Subscription |
Abonnieren von Ereignissen aus einer einzelnen Partition Rufen Sie close() für das zurückgegebene Objekt auf, um den Empfang von Ereignissen zu beenden. Verwendungsbeispiel: |
| subscribe(Subscription |
Abonnieren sie Ereignisse aus allen Partitionen. Wenn prüfpunktspeicher für Rufen Sie close() für das zurückgegebene Objekt auf, um den Empfang von Ereignissen zu beenden. Verwendungsbeispiel: |
Details zum Konstruktor
EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)
Die EventHubConsumerClient -Klasse wird verwendet, um Ereignisse von einem Event Hub zu nutzen.
Verwenden Sie den options Parmeter, um Wiederholungsrichtlinien- oder Proxyeinstellungen zu konfigurieren.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parameter
- consumerGroup
-
string
Der Name der Consumergruppe, aus der Sie Ereignisse verarbeiten möchten.
- connectionString
-
string
Die Verbindungszeichenfolge, die zum Herstellen einer Verbindung mit dem Event Hub-instance verwendet werden soll. Es wird erwartet, dass die Eigenschaften des gemeinsam genutzten Schlüssels und der Event Hub-Pfad in dieser Verbindungszeichenfolge enthalten sind. z.B. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.
- checkpointStore
- CheckpointStore
Ein Prüfpunktspeicher, der vom Client zum Lesen von Prüfpunkten verwendet wird, um die Position zu bestimmen, von der aus die Empfangen von Ereignissen fortgesetzt werden soll, wenn Ihre Anwendung neu gestartet wird. Sie wird auch vom Client verwendet, um einen Lastenausgleich für mehrere Instanzen Ihrer Anwendung zu erstellen.
- options
- EventHubConsumerClientOptions
Eine Reihe von Optionen, die beim Konfigurieren des Clients angewendet werden sollen.
-
retryOptions: Konfiguriert die Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Zum Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert das Channelling der AMQP-Verbindung über Web Sockets. -
userAgent: Eine Zeichenfolge, die an die integrierte Benutzer-Agent-Zeichenfolge angefügt werden soll, die an den Dienst übergeben wird.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)
Die EventHubConsumerClient -Klasse wird verwendet, um Ereignisse von einem Event Hub zu nutzen.
Verwenden Sie den options Parmeter, um Wiederholungsrichtlinien- oder Proxyeinstellungen zu konfigurieren.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)Parameter
- consumerGroup
-
string
Der Name der Consumergruppe, aus der Sie Ereignisse verarbeiten möchten.
- connectionString
-
string
Die Verbindungszeichenfolge, die zum Herstellen einer Verbindung mit dem Event Hub-instance verwendet werden soll. Es wird erwartet, dass die Eigenschaften des gemeinsam genutzten Schlüssels und der Event Hub-Pfad in dieser Verbindungszeichenfolge enthalten sind. z.B. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.
- options
- EventHubConsumerClientOptions
Eine Reihe von Optionen, die beim Konfigurieren des Clients angewendet werden sollen.
-
retryOptions: Konfiguriert die Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Zum Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert das Channelling der AMQP-Verbindung über Web Sockets. -
userAgent: Eine Zeichenfolge, die an die integrierte Benutzer-Agent-Zeichenfolge angefügt werden soll, die an den Dienst übergeben wird.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)
Die EventHubConsumerClient -Klasse wird verwendet, um Ereignisse von einem Event Hub zu nutzen.
Verwenden Sie den options Parmeter, um Wiederholungsrichtlinien- oder Proxyeinstellungen zu konfigurieren.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parameter
- consumerGroup
-
string
Der Name der Consumergruppe, aus der Sie Ereignisse verarbeiten möchten.
- connectionString
-
string
Die Verbindungszeichenfolge, die zum Herstellen einer Verbindung mit dem Event Hubs-Namespace verwendet werden soll. Es wird erwartet, dass die Eigenschaften mit gemeinsam genutzten Schlüsseln in dieser Verbindungszeichenfolge enthalten sind, aber nicht im Event Hub-Pfad, z. B. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.
- eventHubName
-
string
Der Name des spezifischen Event Hubs, mit dem der Client eine Verbindung herstellen soll.
- checkpointStore
- CheckpointStore
Ein Prüfpunktspeicher, der vom Client zum Lesen von Prüfpunkten verwendet wird, um die Position zu bestimmen, von der aus die Empfangen von Ereignissen fortgesetzt werden soll, wenn Ihre Anwendung neu gestartet wird. Sie wird auch vom Client verwendet, um einen Lastenausgleich für mehrere Instanzen Ihrer Anwendung zu erstellen.
- options
- EventHubConsumerClientOptions
Eine Reihe von Optionen, die beim Konfigurieren des Clients angewendet werden sollen.
-
retryOptions: Konfiguriert die Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Zum Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert das Channelling der AMQP-Verbindung über Web Sockets. -
userAgent: Eine Zeichenfolge, die an die integrierte Benutzer-Agent-Zeichenfolge angefügt werden soll, die an den Dienst übergeben wird.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)
Die EventHubConsumerClient -Klasse wird verwendet, um Ereignisse von einem Event Hub zu nutzen.
Verwenden Sie den options Parmeter, um Wiederholungsrichtlinien- oder Proxyeinstellungen zu konfigurieren.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)Parameter
- consumerGroup
-
string
Der Name der Consumergruppe, aus der Sie Ereignisse verarbeiten möchten.
- connectionString
-
string
Die Verbindungszeichenfolge, die zum Herstellen einer Verbindung mit dem Event Hubs-Namespace verwendet werden soll. Es wird erwartet, dass die Eigenschaften mit gemeinsam genutzten Schlüsseln in dieser Verbindungszeichenfolge enthalten sind, aber nicht im Event Hub-Pfad, z. B. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.
- eventHubName
-
string
Der Name des spezifischen Event Hubs, mit dem der Client eine Verbindung herstellen soll.
- options
- EventHubConsumerClientOptions
Eine Reihe von Optionen, die beim Konfigurieren des Clients angewendet werden sollen.
-
retryOptions: Konfiguriert die Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Zum Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert das Channelling der AMQP-Verbindung über Web Sockets. -
userAgent: Eine Zeichenfolge, die an die integrierte Benutzer-Agent-Zeichenfolge angefügt werden soll, die an den Dienst übergeben wird.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)
Die EventHubConsumerClient -Klasse wird verwendet, um Ereignisse von einem Event Hub zu nutzen.
Verwenden Sie den options Parmeter, um Wiederholungsrichtlinien- oder Proxyeinstellungen zu konfigurieren.
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parameter
- consumerGroup
-
string
Der Name der Consumergruppe, aus der Sie Ereignisse verarbeiten möchten.
- fullyQualifiedNamespace
-
string
Der vollständige Namespace, der wahrscheinlich .servicebus.windows.net
- eventHubName
-
string
Der Name des spezifischen Event Hubs, mit dem der Client eine Verbindung herstellen soll.
- credential
Ein Anmeldeinformationsobjekt, das vom Client verwendet wird, um das Token abzurufen, um die Verbindung mit dem Azure Event Hubs-Dienst zu authentifizieren.
Informationen zum Erstellen von Anmeldeinformationen, die die AAD-Authentifizierung unterstützen, finden Sie unter @azure/Identität. Verwenden Sie from AzureNamedKeyCredential @azure/core-auth, wenn Sie und SharedAccessKeyNameSharedAccessKey ohne Verwendung einer Verbindungszeichenfolge übergeben möchten. Diese Felder werden dem name Feld und key in AzureNamedKeyCredentialzugeordnet.
Verwenden Sie from AzureSASCredential @azure/core-auth, wenn Sie ein SharedAccessSignature übergeben möchten, ohne eine Verbindungszeichenfolge zu verwenden. Dieses Feld wird in AzureSASCredentialzugeordnetsignature.
- checkpointStore
- CheckpointStore
Ein Prüfpunktspeicher, der vom Client zum Lesen von Prüfpunkten verwendet wird, um die Position zu bestimmen, von der aus die Empfangen von Ereignissen fortgesetzt werden soll, wenn Ihre Anwendung neu gestartet wird. Sie wird auch vom Client verwendet, um einen Lastenausgleich für mehrere Instanzen Ihrer Anwendung zu erstellen.
- options
- EventHubConsumerClientOptions
Eine Reihe von Optionen, die beim Konfigurieren des Clients angewendet werden sollen.
-
retryOptions: Konfiguriert die Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Zum Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert das Channelling der AMQP-Verbindung über Web Sockets. -
userAgent: Eine Zeichenfolge, die an die integrierte Benutzer-Agent-Zeichenfolge angefügt werden soll, die an den Dienst übergeben wird.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)
Die EventHubConsumerClient -Klasse wird verwendet, um Ereignisse von einem Event Hub zu nutzen.
Verwenden Sie den options Parmeter, um Wiederholungsrichtlinien- oder Proxyeinstellungen zu konfigurieren.
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)Parameter
- consumerGroup
-
string
Der Name der Consumergruppe, aus der Sie Ereignisse verarbeiten möchten.
- fullyQualifiedNamespace
-
string
Der vollständige Namespace, der wahrscheinlich .servicebus.windows.net
- eventHubName
-
string
Der Name des spezifischen Event Hubs, mit dem der Client eine Verbindung herstellen soll.
- credential
Ein Anmeldeinformationsobjekt, das vom Client verwendet wird, um das Token abzurufen, um die Verbindung mit dem Azure Event Hubs-Dienst zu authentifizieren.
Informationen zum Erstellen von Anmeldeinformationen, die die AAD-Authentifizierung unterstützen, finden Sie unter @azure/Identität. Verwenden Sie from AzureNamedKeyCredential @azure/core-auth, wenn Sie und SharedAccessKeyNameSharedAccessKey ohne Verwendung einer Verbindungszeichenfolge übergeben möchten. Diese Felder werden dem name Feld und key in AzureNamedKeyCredentialzugeordnet.
Verwenden Sie from AzureSASCredential @azure/core-auth, wenn Sie ein SharedAccessSignature übergeben möchten, ohne eine Verbindungszeichenfolge zu verwenden. Dieses Feld wird in AzureSASCredentialzugeordnetsignature.
- options
- EventHubConsumerClientOptions
Eine Reihe von Optionen, die beim Konfigurieren des Clients angewendet werden sollen.
-
retryOptions: Konfiguriert die Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Zum Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert das Channelling der AMQP-Verbindung über Web Sockets. -
userAgent: Eine Zeichenfolge, die an die integrierte Benutzer-Agent-Zeichenfolge angefügt werden soll, die an den Dienst übergeben wird.
Details zur Eigenschaft
defaultConsumerGroupName
Der Name der Standardconsumergruppe im Event Hubs-Dienst.
static defaultConsumerGroupName: stringEigenschaftswert
string
eventHubName
Der Name des Event Hub-instance, für den dieser Client erstellt wird.
string eventHubNameEigenschaftswert
string
fullyQualifiedNamespace
Der vollqualifizierte Namespace des Event Hub-instance, für den dieser Client erstellt wird. Dies ist wahrscheinlich ähnlich wie servicebus.windows.net.
string fullyQualifiedNamespaceEigenschaftswert
string
identifier
Der Name, der verwendet wird, um diesen EventHubConsumerClient zu identifizieren. Wenn nicht angegeben oder leer, wird eine zufällige eindeutige generiert.
identifier: stringEigenschaftswert
string
Details zur Methode
close()
Schließt die AMQP-Verbindung mit dem Event Hub-instance und gibt eine Zusage zurück, die aufgelöst wird, wenn die Trennung abgeschlossen ist.
function close(): Promise<void>Gibt zurück
Promise<void>
Promise
getEventHubProperties(GetEventHubPropertiesOptions)
Stellt die Event Hub-Laufzeitinformationen bereit.
function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>Parameter
- options
- GetEventHubPropertiesOptions
Der Satz von Optionen, die auf den Vorgangsaufruf angewendet werden sollen.
Gibt zurück
Promise<EventHubProperties>
Eine Zusage, die mit Informationen zum Event Hub-instance aufgelöst wird.
getPartitionIds(GetPartitionIdsOptions)
Stellt die ID für jede Partition bereit, die dem Event Hub zugeordnet ist.
function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>Parameter
- options
- GetPartitionIdsOptions
Der Satz von Optionen, die auf den Vorgangsaufruf angewendet werden sollen.
Gibt zurück
Promise<string[]>
Eine Zusage, die mit einem Array von Zeichenfolgen aufgelöst wird, das die ID für jede Partition darstellt, die dem Event Hub zugeordnet ist.
getPartitionProperties(string, GetPartitionPropertiesOptions)
Stellt Informationen zum Status der angegebenen Partition bereit.
function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>Parameter
- partitionId
-
string
Die ID der Partition, für die Informationen erforderlich sind.
- options
- GetPartitionPropertiesOptions
Der Satz von Optionen, die auf den Vorgangsaufruf angewendet werden sollen.
Gibt zurück
Promise<PartitionProperties>
Eine Zusage, die mit Informationen zum Zustand der Partition aufgelöst wird.
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)
Abonnieren von Ereignissen aus einer einzelnen Partition Rufen Sie close() für das zurückgegebene Objekt auf, um den Empfang von Ereignissen zu beenden.
Verwendungsbeispiel:
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): SubscriptionParameter
- partitionId
-
string
Die ID der zu abonnierenden Partition.
- handlers
- SubscriptionEventHandlers
Handler für den Lebenszyklus des Abonnements: Abonnementinitialisierung der Partition, Empfangen von Ereignissen, Behandeln von Fehlern und Schließen eines Abonnements für die Partition.
- options
- SubscribeOptions
Konfiguriert die Art und Weise, wie Ereignisse empfangen werden.
Am häufigsten sind maxBatchSize und maxWaitTimeInSeconds steuern den Ablauf von Ereignissen an den Handler, der zum Empfangen von Ereignissen bereitgestellt wird, sowie die Startposition. Zum Beispiel, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Gibt zurück
subscribe(SubscriptionEventHandlers, SubscribeOptions)
Abonnieren sie Ereignisse aus allen Partitionen.
Wenn prüfpunktspeicher für EventHubConsumerClient bereitgestellt wird und mehrere Instanzen Ihrer Anwendung vorhanden sind, abonniert jede instance eine Teilmenge der Partitionen, sodass die Last unter ihnen ausgeglichen wird.
Rufen Sie close() für das zurückgegebene Objekt auf, um den Empfang von Ereignissen zu beenden.
Verwendungsbeispiel:
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): SubscriptionParameter
- handlers
- SubscriptionEventHandlers
Handler für den Lebenszyklus des Abonnements: Abonnementinitialisierung pro Partition, Empfangen von Ereignissen, Behandeln von Fehlern und Schließen eines Abonnements pro Partition.
- options
- SubscribeOptions
Konfiguriert die Art und Weise, wie Ereignisse empfangen werden.
Am häufigsten sind maxBatchSize und maxWaitTimeInSeconds steuern den Ablauf von Ereignissen an den Handler, der zum Empfangen von Ereignissen bereitgestellt wird, sowie die Startposition. Zum Beispiel, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }