Freigeben über

EventHubClientOptions interface

  • Referenz
Paket:
@azure/event-hubs

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

  • 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 des Channellings 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, die an den Websocket-Konstruktor übergeben werden sollen, wenn Sie die Verbindung über ein WebSocket herstellen möchten.
  • retryOptions : Die Wiederholungsoptionen für alle Vorgänge auf dem Client/Producer/Consumer.
    • maxRetries : Gibt an, wie oft der Vorgang im Falle eines wiederholungsfähigen Fehlers wiederholt werden kann.
    • maxRetryDelayInMs: Die maximale Verzögerung zwischen Wiederholungen. Gilt nur bei exponentiellen Wiederholungsversuchen.
    • mode: Der anzuwendende Wiederholungsmodus, der durch die RetryMode Enumeration angegeben wird. Die Optionen sind Exponential und Fixed. Der Standardwert lautet Fixed.
    • retryDelayInMs: Der Zeitraum, der in Millisekunden gewartet werden soll, 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. Standardwert: 30000 Millisekunden.
    • timeoutInMs: Die Wartezeit in Millisekunden, bis ein Timeout für den Vorgang auftritt. Dadurch wird ein Wiederholungsversuch ausgelöst, wenn noch Wiederholungsversuche vorhanden sind. Standardwert: 60000 Millisekunden.

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

Beispielverwendung:

{
    retryOptions: {
        maxRetries: 4
    }
}

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

Details zur Eigenschaft

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

identifier

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

identifier?: string

Eigenschaftswert

string

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

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

webSocketOptions

Optionen zum Konfigurieren des Channellings der AMQP-Verbindung über Websockets.

webSocketOptions?: WebSocketOptions

Eigenschaftswert

WebSocketOptions