@azure/event-hubs package
Klassen
EventHubBufferedProducerClient |
Wird Ereignisse Je nach den Optionen, die beim Queuieren von Ereignissen angegeben werden, können sie automatisch einer Partition zugewiesen, nach dem angegebenen Partitionsschlüssel gruppiert oder einer speziell angeforderten Partition zugewiesen werden. Dieses Modell soll die Belastung der Batchverwaltung von Anrufern auf Kosten eines nicht deterministischen Zeitpunkts für den Zeitpunkt der Veröffentlichung von Ereignissen verlagern. Es gibt auch zusätzliche Kompromisse, die zu berücksichtigen sind:
In Szenarien, in denen es wichtig ist, Ereignisse sofort mit einem deterministischen Ergebnis zu veröffentlichen, stellen Sie sicher, dass Partitionsschlüssel einer Partition zugewiesen werden, die mit anderen Herausgebern konsistent ist, oder wenn die Maximierung der Verfügbarkeit eine Anforderung ist, wird die Verwendung von |
EventHubConsumerClient |
Die Es gibt mehrere Möglichkeiten, eine
Optional können Sie auch Folgendes übergeben:
|
EventHubProducerClient |
Die Es gibt mehrere Möglichkeiten, eine
Optional können Sie auch eine Optionstasche übergeben, um die Wiederholungsrichtlinie oder proxyeinstellungen zu konfigurieren. |
MessagingError |
Beschreibt die Basisklasse für MessagingFehler. |
Schnittstellen
BufferedCloseOptions |
Optionen zum Konfigurieren der |
BufferedFlushOptions |
Optionen zum Konfigurieren der |
Checkpoint |
Ein Prüfpunkt soll das letzte erfolgreich verarbeitete Ereignis des Benutzers aus einer bestimmten Partition einer Consumergruppe in einem Event Hub-instance darstellen. Wenn die Es wird nie erwartet, dass Benutzer direkt mit |
CheckpointStore |
Ein Prüfpunktspeicher speichert und ruft Partitionsbesitzinformationen und Prüfpunktdetails für jede Partition in einer bestimmten Consumergruppe eines Event Hub-instance ab. Benutzer sind nicht dafür vorgesehen, ein Implementierungen von |
CreateBatchOptions |
Optionen zum Konfigurieren der
Beispielverwendung:
|
EnqueueEventOptions |
Optionen zum Konfigurieren der |
EventData |
Die Schnittstelle, die die Daten beschreibt, die an Event Hub gesendet werden sollen.
Verwenden Sie dies als Verweis beim Erstellen des -Objekts, das bei Verwendung von
|
EventDataAdapterParameters |
Parameter für die |
EventDataBatch |
Eine Schnittstelle, die einen Batch von Ereignissen darstellt, die zum Senden von Ereignissen an Event Hub verwendet werden können. Verwenden Sie zum Erstellen des Batches die |
EventHubBufferedProducerClientOptions |
Beschreibt die Optionen, die beim Erstellen von |
EventHubClientOptions |
Beschreibt die Optionen, die beim Erstellen des EventHubClients bereitgestellt werden können.
Eine einfache Verwendung kann sein Beispielverwendung:
|
EventHubConnectionStringProperties |
Der Satz von Eigenschaften, die eine Event Hub-Verbindungszeichenfolge. |
EventHubConsumerClientOptions |
Beschreibt die Optionen, die beim Erstellen von EventHubConsumerClient bereitgestellt werden können.
Eine einfache Verwendung kann sein Beispielverwendung:
|
EventHubProperties |
Beschreibt die Laufzeitinformationen eines Event Hubs. |
EventPosition |
Stellt die Position eines Ereignisses in einer Event Hub-Partition dar, die in der Regel beim Aufrufen der Um eine EventPosition abzurufen, die den Anfang oder das Ende des Datenstroms darstellt, verwenden Sie die Konstanten |
GetEventHubPropertiesOptions |
Der Satz von Optionen zum Konfigurieren des Verhaltens von
|
GetPartitionIdsOptions |
Der Satz von Optionen zum Konfigurieren des Verhaltens von
|
GetPartitionPropertiesOptions |
Der Satz von Optionen zum Konfigurieren des Verhaltens von
|
LastEnqueuedEventProperties |
Eine Reihe von Informationen zum letzten in Warteschlange gestellten Ereignis einer Partition, die vom Consumer beobachtet wird, wenn Ereignisse vom Event Hubs-Dienst empfangen werden. |
LoadBalancingOptions |
Eine Optionstasche zum Konfigurieren von Lastenausgleichseinstellungen. |
OnSendEventsErrorContext |
Enthält die Ereignisse, die nicht erfolgreich an den Event Hub gesendet wurden, die Partition, der sie zugewiesen wurden, und den Fehler, der beim Senden aufgetreten ist. |
OnSendEventsSuccessContext |
Enthält die Ereignisse, die erfolgreich an den Event Hub gesendet wurden, und die Partition, der sie zugewiesen wurden. |
OperationOptions |
Optionen zum Konfigurieren der Ablaufverfolgung und des abortSignals. |
PartitionContext |
Schnittstelle, die den Kontext beschreibt, der an jede der Funktionen übergeben wird, die Teil von |
PartitionOwnership |
Eine Schnittstelle, die die Details darstellt, auf denen instance einer
Hinweis: Dies wird intern von verwendet, und der |
PartitionProperties |
Beschreibt die Laufzeitinformationen einer EventHub-Partition. |
ReceivedEventData |
Die Schnittstelle, die die Struktur des von Event Hub empfangenen Ereignisses beschreibt.
Verwenden Sie dies als Verweis beim Erstellen der |
RetryOptions |
Wiederholungsrichtlinienoptionen, die den Modus, die Anzahl der Wiederholungen, das Wiederholungsintervall usw. bestimmen. |
SendBatchOptions |
Optionen zum Konfigurieren der
|
SubscribeOptions |
Optionen zum Konfigurieren der |
Subscription |
Schnittstelle, die das von der |
SubscriptionEventHandlers |
Schnittstelle, die die vom Benutzer zu implementierenden Funktionen beschreibt, die beim Aufruf der |
TokenCredential |
Stellt eine Anmeldeinformation dar, die ein Authentifizierungstoken bereitstellen kann. |
TryAddOptions |
Optionen zum Konfigurieren des Verhaltens der |
WebSocketImpl |
Beschreibt die erforderliche Form von WebSocket-Konstruktoren. |
WebSocketOptions |
Optionen zum Konfigurieren der Kanalerstellung der AMQP-Verbindung über Websockets. |
Typaliase
ProcessCloseHandler |
Signatur der vom Benutzer bereitgestellten Funktion, die direkt |
ProcessErrorHandler |
Die Signatur der vom Benutzer bereitgestellten Funktion wird |
ProcessEventsHandler |
Signatur der vom Benutzer bereitgestellten Funktion, die aufgerufen wird |
ProcessInitializeHandler |
Signatur der vom Benutzer bereitgestellten Funktion, die kurz vor dem Empfang von Ereignissen von einer Partition aufgerufen wird |
Enumerationen
CloseReason |
Eine Enumeration, die die verschiedenen Gründe für das |
RetryMode |
Beschreibt den Wiederholungsmodustyp |
Functions
create |
Eine Funktion, die einen Ereignisdatenadapter erstellt. Dieser Adapter kann zum |
parse |
Analysiert Verbindungszeichenfolge die verschiedenen Eigenschaften, die für Azure Event Hubs gelten. Die Eigenschaften sind nützlich, um dann einen EventHubProducerClient oder einen EventHubConsumerClient zu erstellen. |
Details zur Funktion
createEventDataAdapter(EventDataAdapterParameters)
Eine Funktion, die einen Ereignisdatenadapter erstellt. Dieser Adapter kann zum @azure/schema-registry-avro
Codieren und Decodieren von Text in Ereignisdaten verwendet werden.
function createEventDataAdapter(params?: EventDataAdapterParameters): MessageAdapter<EventData>
Parameter
- params
- EventDataAdapterParameters
Parameter zum Erstellen der Ereignisdaten
Gibt zurück
MessageAdapter<EventData>
Ein Ereignisdatenadapter, der Ereignisdaten erzeugen und nutzen kann
parseEventHubConnectionString(string)
Analysiert Verbindungszeichenfolge die verschiedenen Eigenschaften, die für Azure Event Hubs gelten. Die Eigenschaften sind nützlich, um dann einen EventHubProducerClient oder einen EventHubConsumerClient zu erstellen.
function parseEventHubConnectionString(connectionString: string): Readonly<EventHubConnectionStringProperties>
Parameter
- connectionString
-
string
Die Verbindungszeichenfolge der Shared Access Policy zugeordnet, die für den Event Hubs-Namespace erstellt wurde.
Gibt zurück
Readonly<EventHubConnectionStringProperties>