Freigeben über

EventHubConsumerClientOptions interface

  • Referenz
Paket:
@azure/event-hubs

Beschreibt die Optionen, die beim Erstellen des EventHubConsumerClient bereitgestellt werden können.

  • loadBalancingOptions: Optionen zum Optimieren der EventHubConsumerClient-Anspruchspartitionen.
  • userAgent: Eine Zeichenfolge, die an die integrierte Benutzer-Agent-Zeichenfolge angefügt werden soll, die als Verbindungseigenschaft an den Dienst übergeben wird.
  • webSocketOptions: Optionen zum Konfigurieren der Kanalierung der AMQP-Verbindung über Web Sockets.
    • websocket: Der WebSocket-Konstruktor, der zum Erstellen einer AMQP-Verbindung verwendet wird, wenn Sie die Verbindung über ein WebSocket herstellen möchten.
    • webSocketConstructorOptions: Optionen zum Übergeben an den Websocket-Konstruktor, wenn Sie die Verbindung über ein WebSocket herstellen möchten.
  • retryOptions: Die Wiederholungsoptionen für alle Vorgänge auf dem Client/Produzent/Verbraucher.
    • maxRetries: Die Anzahl der Wiederholungsversuche des Vorgangs im Falle eines wiederholungsfähigen Fehlers.
    • maxRetryDelayInMs: Die maximale Verzögerung zwischen Wiederholungen. Gilt nur, wenn exponentielle Wiederholungen ausgeführt werden.
    • mode: Welcher Wiederholungsmodus angewendet werden soll, angegeben durch die RetryMode Enumeration. Optionen sind Exponential und Fixed. Standardmäßig wird Fixed.
    • retryDelayInMs: Zeitaufwand für die Wartezeit in Millisekunden, bevor der nächste Versuch unternommen wird. Wenn mode auf Exponentialfestgelegt ist, wird dies verwendet, um die exponentiell steigenden Verzögerungen zwischen Wiederholungen zu berechnen. Standard: 30000 Millisekunden.
    • timeoutInMs: Zeit in Millisekunden, bis der Vorgang ausläuft. Dadurch wird ein Wiederholungsversuch ausgelöst, wenn wiederholungsversuche noch vorhanden sind. Standardwert: 60000 Millisekunden.

Eine einfache Verwendung kann { "maxRetries": 4 }werden.

Beispielverwendung:

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends
EventHubClientOptions

Eigenschaften

loadBalancingOptions

Optionen zum Optimieren der EventHubConsumerClient-Anspruchspartitionen.

Geerbte Eigenschaften

customEndpointAddress

Ein benutzerdefinierter Endpunkt, der beim Herstellen einer Verbindung mit dem Event Hubs-Dienst verwendet werden soll. Dies kann nützlich sein, wenn Ihr Netzwerk keine Verbindung mit der standardmäßigen Azure Event Hubs-Endpunktadresse zulässt, die Verbindung aber über einen Zwischenhändler ermöglicht.

Beispiel: "https://my.custom.endpoint:100/"
identifier

Ein eindeutiger Name, der zum Identifizieren des Clients verwendet wird. Wenn nicht angegeben, wird eine GUID als Bezeichner verwendet.
retryOptions

Optionen zum Konfigurieren der Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Beispiel: { "maxRetries": 4 } oder { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Wert, der an die integrierte Benutzer-Agent-Zeichenfolge angefügt wird, die an den Event Hubs-Dienst übergeben wird.
webSocketOptions

Optionen zum Konfigurieren der Kanalierung der AMQP-Verbindung über Web Sockets.

Details zur Eigenschaft

loadBalancingOptions

Optionen zum Optimieren der EventHubConsumerClient-Anspruchspartitionen.

loadBalancingOptions?: LoadBalancingOptions

Eigenschaftswert

LoadBalancingOptions

Geerbte Eigenschaftsdetails

customEndpointAddress

Ein benutzerdefinierter Endpunkt, der beim Herstellen einer Verbindung mit dem Event Hubs-Dienst verwendet werden soll. Dies kann nützlich sein, wenn Ihr Netzwerk keine Verbindung mit der standardmäßigen Azure Event Hubs-Endpunktadresse zulässt, die Verbindung aber über einen Zwischenhändler ermöglicht.

Beispiel: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

Eigenschaftswert

string

geerbt vonEventHubClientOptions.customEndpointAddress

identifier

Ein eindeutiger Name, der zum Identifizieren des Clients verwendet wird. Wenn nicht angegeben, wird eine GUID als Bezeichner verwendet.

identifier?: string

Eigenschaftswert

string

vonEventHubClientOptions.identifier geerbt

retryOptions

Optionen zum Konfigurieren der Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Beispiel: { "maxRetries": 4 } oder { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Eigenschaftswert

RetryOptions

geerbt vonEventHubClientOptions.retryOptions

userAgent

Wert, der an die integrierte Benutzer-Agent-Zeichenfolge angefügt wird, die an den Event Hubs-Dienst übergeben wird.

userAgent?: string

Eigenschaftswert

string

geerbt vonEventHubClientOptions.userAgent-

webSocketOptions

Optionen zum Konfigurieren der Kanalierung der AMQP-Verbindung über Web Sockets.

webSocketOptions?: WebSocketOptions

Eigenschaftswert

WebSocketOptions

vonEventHubClientOptions.webSocketOptions