EventHubConsumerClient class
Die EventHubConsumerClient Klasse wird verwendet, um Ereignisse von einem Event Hub zu nutzen.
Es gibt mehrere Möglichkeiten zum Erstellen eines EventHubConsumerClient
- Verwenden Sie die Verbindungszeichenfolge aus der SAS-Richtlinie, die für Ihre Event Hub-Instanz erstellt wurde.
- Verwenden Sie die Verbindungszeichenfolge aus der SAS-Richtlinie, die für Ihren Event Hub-Namespace erstellt wurde, und den Namen der Event Hub-Instanz.
- Verwenden Sie den vollständigen Namespace wie
<yournamespace>.servicebus.windows.netund ein Anmeldeinformationsobjekt.
Optional können Sie auch Folgendes übergeben:
- Ein Optionsbehälter zum Konfigurieren der Wiederholungsrichtlinie oder Proxyeinstellungen.
- Ein Prüfpunktspeicher, der vom Client verwendet wird, um Prüfpunkte zu lesen, um die Position zu bestimmen, an der er den Empfang von Ereignissen fortsetzen soll, wenn die Anwendung neu gestartet wird. Der Prüfpunktspeicher wird auch vom Client verwendet, um mehrere Instanzen Ihrer Anwendung zu laden.
Konstruktoren
| Event |
Die |
| Event |
Die |
| Event |
Die |
| Event |
Die |
| Event |
Die |
| Event |
Die |
Eigenschaften
| default |
Der Name der Standard-Consumergruppe im Event Hubs-Dienst. |
| event |
Der Name der Event Hub-Instanz, für die dieser Client erstellt wird. |
| fully |
Der vollqualifizierte Namespace der Event Hub-Instanz, für die dieser Client erstellt wird. Dies ist wahrscheinlich mit .servicebus.windows.net vergleichbar. |
| identifier | Der Name, der zum Identifizieren dieses EventHubConsumerClient verwendet wird. Wenn sie nicht angegeben oder leer ist, wird ein zufällig eindeutiger Wert generiert. |
Methoden
| close() | Schließt die AMQP-Verbindung mit der Event Hub-Instanz und gibt eine Zusage zurück, die aufgelöst wird, wenn die Verbindung 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 sie Ereignisse aus einer einzelnen Partition. Rufen Sie close() für das zurückgegebene Objekt auf, um den Empfang von Ereignissen zu beenden. Beispielverwendung: |
| subscribe(Subscription |
Abonnieren Sie Ereignisse von allen Partitionen. Wenn der Prüfpunktspeicher für die Rufen Sie close() für das zurückgegebene Objekt auf, um den Empfang von Ereignissen zu beenden. Beispielverwendung: |
Details zum Konstruktor
EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)
Die EventHubConsumerClient Klasse wird verwendet, um Ereignisse von einem Event Hub zu nutzen.
Verwenden Sie das options Parmeter zum Konfigurieren von Wiederholungsrichtlinien oder Proxyeinstellungen.
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 der Event Hub-Instanz verwendet werden soll. Es wird erwartet, dass die eigenschaften des freigegebenen 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 verwendet wird, um Prüfpunkte zu lesen, um die Position zu bestimmen, an der er den Empfang von Ereignissen fortsetzen soll, wenn die Anwendung neu gestartet wird. Es wird auch vom Client verwendet, um mehrere Instanzen Ihrer Anwendung zu laden.
- 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. Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert die Kanalierung 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 das options Parmeter zum Konfigurieren von Wiederholungsrichtlinien oder Proxyeinstellungen.
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 der Event Hub-Instanz verwendet werden soll. Es wird erwartet, dass die eigenschaften des freigegebenen 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. Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert die Kanalierung 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 das options Parmeter zum Konfigurieren von Wiederholungsrichtlinien oder Proxyeinstellungen.
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 gemeinsam genutzten Schlüsseleigenschaften in dieser Verbindungszeichenfolge enthalten sind, aber nicht der 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 verbunden werden soll.
- checkpointStore
- CheckpointStore
Ein Prüfpunktspeicher, der vom Client verwendet wird, um Prüfpunkte zu lesen, um die Position zu bestimmen, an der er den Empfang von Ereignissen fortsetzen soll, wenn die Anwendung neu gestartet wird. Es wird auch vom Client verwendet, um mehrere Instanzen Ihrer Anwendung zu laden.
- 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. Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert die Kanalierung 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 das options Parmeter zum Konfigurieren von Wiederholungsrichtlinien oder Proxyeinstellungen.
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 gemeinsam genutzten Schlüsseleigenschaften in dieser Verbindungszeichenfolge enthalten sind, aber nicht der 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 verbunden werden 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. Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert die Kanalierung 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 das options Parmeter zum Konfigurieren von Wiederholungsrichtlinien oder Proxyeinstellungen.
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 mit .servicebus.windows.net
- eventHubName
-
string
Der Name des spezifischen Event Hubs, mit dem der Client verbunden werden 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 die AzureNamedKeyCredential aus @azure/Core-Auth, wenn Sie eine SharedAccessKeyName und SharedAccessKey ohne Verbindungszeichenfolge übergeben möchten. Diese Felder werden dem feld name bzw. key feld in AzureNamedKeyCredentialzugeordnet.
Verwenden Sie die AzureSASCredential aus @azure/core-auth, wenn Sie eine SharedAccessSignature ohne Verbindungszeichenfolge übergeben möchten. Dieses Feld ist in AzureSASCredentialsignature zugeordnet.
- checkpointStore
- CheckpointStore
Ein Prüfpunktspeicher, der vom Client verwendet wird, um Prüfpunkte zu lesen, um die Position zu bestimmen, an der er den Empfang von Ereignissen fortsetzen soll, wenn die Anwendung neu gestartet wird. Es wird auch vom Client verwendet, um mehrere Instanzen Ihrer Anwendung zu laden.
- 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. Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert die Kanalierung 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 das options Parmeter zum Konfigurieren von Wiederholungsrichtlinien oder Proxyeinstellungen.
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 mit .servicebus.windows.net
- eventHubName
-
string
Der Name des spezifischen Event Hubs, mit dem der Client verbunden werden 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 die AzureNamedKeyCredential aus @azure/Core-Auth, wenn Sie eine SharedAccessKeyName und SharedAccessKey ohne Verbindungszeichenfolge übergeben möchten. Diese Felder werden dem feld name bzw. key feld in AzureNamedKeyCredentialzugeordnet.
Verwenden Sie die AzureSASCredential aus @azure/core-auth, wenn Sie eine SharedAccessSignature ohne Verbindungszeichenfolge übergeben möchten. Dieses Feld ist in AzureSASCredentialsignature zugeordnet.
- 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. Beispiel:{ "maxRetries": 4 }oder{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: Konfiguriert die Kanalierung 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 Standard-Consumergruppe im Event Hubs-Dienst.
static defaultConsumerGroupName: stringEigenschaftswert
string
eventHubName
Der Name der Event Hub-Instanz, für die dieser Client erstellt wird.
string eventHubNameEigenschaftswert
string
fullyQualifiedNamespace
Der vollqualifizierte Namespace der Event Hub-Instanz, für die dieser Client erstellt wird. Dies ist wahrscheinlich mit .servicebus.windows.net vergleichbar.
string fullyQualifiedNamespaceEigenschaftswert
string
identifier
Der Name, der zum Identifizieren dieses EventHubConsumerClient verwendet wird. Wenn sie nicht angegeben oder leer ist, wird ein zufällig eindeutiger Wert generiert.
identifier: stringEigenschaftswert
string
Details zur Methode
close()
Schließt die AMQP-Verbindung mit der Event Hub-Instanz und gibt eine Zusage zurück, die aufgelöst wird, wenn die Verbindung abgeschlossen ist.
function close(): Promise<void>Gibt zurück
Promise<void>
Versprechen
getEventHubProperties(GetEventHubPropertiesOptions)
Stellt die Event Hub-Laufzeitinformationen bereit.
function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>Parameter
- options
- GetEventHubPropertiesOptions
Die Gruppe von Optionen, die auf den Vorgangsaufruf angewendet werden sollen.
Gibt zurück
Promise<EventHubProperties>
Eine Zusage, die mit Informationen zur Event Hub-Instanz 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
Die Gruppe 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, die 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
Die Gruppe 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 sie Ereignisse aus einer einzelnen Partition. Rufen Sie close() für das zurückgegebene Objekt auf, um den Empfang von Ereignissen zu beenden.
Beispielverwendung:
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 Partition, die abonniert werden soll.
- 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, wie Ereignisse empfangen werden.
Die häufigsten sind maxBatchSize und maxWaitTimeInSeconds, die den Ablauf von Ereignissen an den Handler steuern, der zum Empfangen von Ereignissen sowie zur Startposition bereitgestellt wird. Beispiel: { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Gibt zurück
subscribe(SubscriptionEventHandlers, SubscribeOptions)
Abonnieren Sie Ereignisse von allen Partitionen.
Wenn der Prüfpunktspeicher für die EventHubConsumerClient bereitgestellt wird und mehrere Instanzen Ihrer Anwendung vorhanden sind, abonniert jede Instanz 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.
Beispielverwendung:
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, wie Ereignisse empfangen werden.
Die häufigsten sind maxBatchSize und maxWaitTimeInSeconds, die den Ablauf von Ereignissen an den Handler steuern, der zum Empfangen von Ereignissen sowie zur Startposition bereitgestellt wird. Beispiel: { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }