EventHubConsumerClientOptions interface

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

  • loadBalancingOptions: Optionen zum Optimieren, wie der EventHubConsumerClient Partitionen beansprucht.
  • 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 Kanalerstellung der AMQP-Verbindung über Websockets.
    • 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/Producer/Consumer.
    • maxRetries : Die Anzahl der Wiederholungen des Vorgangs im Falle eines wiederholungsfähigen Fehlers.
    • maxRetryDelayInMs: Die maximale Verzögerung zwischen Wiederholungen. Gilt nur für exponentielle Wiederholungen.
    • mode: Welcher Wiederholungsmodus angewendet werden soll, der durch die RetryMode Aufzählung angegeben wird. Die Optionen sind Exponential und Fixed. Wird standardmäßig auf Fixed festgelegt.
    • retryDelayInMs: Die Zeit, die in Millisekunden gewartet werden muss, bevor sie den nächsten Versuch unternehmen. Wenn mode auf Exponentialfestgelegt ist, wird dies verwendet, um die exponentiell steigenden Verzögerungen zwischen Wiederholungen zu berechnen. Standardwert: 30000 Millisekunden.
    • timeoutInMs: Die Wartezeit in Millisekunden, bis das Timeout des Vorgangs auftritt. Dadurch wird ein Wiederholungsversuch ausgelöst, wenn noch Wiederholungsversuche vorhanden sind. Mindestwert: 60000 Millisekunden.

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

Beispielverwendung:

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends

Eigenschaften

loadBalancingOptions

Optionen zum Optimieren der Ansprüche von EventHubConsumerClient-Partitionen.

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 Standard-Azure Event Hubs-Endpunktadresse zulässt, aber eine Verbindung über einen Vermittler zulässt.

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

identifier

Ein eindeutiger Name, der zur Identifizierung des Clients verwendet wird. Falls nicht angegeben, wird eine GUID als Bezeichner verwendet.

retryOptions

Optionen zum Konfigurieren der Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Zum 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 Kanalerstellung der AMQP-Verbindung über Websockets.

Details zur Eigenschaft

loadBalancingOptions

Optionen zum Optimieren der Ansprüche von EventHubConsumerClient-Partitionen.

loadBalancingOptions?: LoadBalancingOptions

Eigenschaftswert

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 Standard-Azure Event Hubs-Endpunktadresse zulässt, aber eine Verbindung über einen Vermittler zulässt.

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

customEndpointAddress?: string

Eigenschaftswert

string

Geerbt vonEventHubClientOptions.customEndpointAddress

identifier

Ein eindeutiger Name, der zur Identifizierung des Clients verwendet wird. Falls nicht angegeben, wird eine GUID als Bezeichner verwendet.

identifier?: string

Eigenschaftswert

string

Geerbt vonEventHubClientOptions.identifier

retryOptions

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

retryOptions?: RetryOptions

Eigenschaftswert

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 Kanalerstellung der AMQP-Verbindung über Websockets.

webSocketOptions?: WebSocketOptions

Eigenschaftswert

Geerbt vonEventHubClientOptions.webSocketOptions