Udostępnij za pośrednictwem

EventHubConsumerClientOptions interface

  • Odwołanie
Pakiet:
@azure/event-hubs

Opisuje opcje, które można udostępnić podczas tworzenia obiektu EventHubConsumerClient.

  • loadBalancingOptions: Opcje dostrajania sposobu partycjonowania oświadczeń eventHubConsumerClient.
  • userAgent : ciąg dołączany do wbudowanych parametrów agenta użytkownika przekazywanych jako właściwość połączenia z usługą.
  • webSocketOptions: Opcje konfigurowania kanału połączenia AMQP za pośrednictwem gniazd sieci Web.
    • websocket: konstruktor Protokołu WebSocket używany do tworzenia połączenia protokołu AMQP, jeśli zdecydujesz się nawiązać połączenie za pośrednictwem protokołu WebSocket.
    • webSocketConstructorOptions: Opcje przekazywania do konstruktora protokołu Websocket podczas wybierania połączenia za pośrednictwem protokołu WebSocket.
  • retryOptions: opcje ponawiania dla wszystkich operacji na kliencie/producencie/odbiorcy.
    • maxRetries: liczba ponownych prób wykonania operacji w przypadku błędu możliwego do ponowienia próby.
    • maxRetryDelayInMs: maksymalne opóźnienie między ponowną próbą. Dotyczy tylko podczas wykonywania ponownych prób wykładniczych.
    • mode: który tryb ponawiania próby ma być stosowany, określony przez wyliczenie RetryMode. Opcje to Exponential i Fixed. Wartość domyślna to Fixed.
    • retryDelayInMs: czas oczekiwania w milisekundach przed podjęciem następnej próby. Gdy mode jest ustawiona na Exponential, służy do obliczania wykładniczo rosnących opóźnień między ponownymi próbami. Wartość domyślna: 30000 milisekund.
    • timeoutInMs: czas oczekiwania w milisekundach przed przekroczeniem limitu czasu operacji. Spowoduje to wyzwolenie ponawiania próby w przypadku pozostałych ponownych prób. Wartość domyślna: 60000 milisekund.

Proste użycie może być { "maxRetries": 4 }.

Przykładowe użycie:

{
    retryOptions: {
        maxRetries: 4
    }
}
Rozszerzenie
EventHubClientOptions

Właściwości

loadBalancingOptions

Opcje dostrajania sposobu partycjonowania oświadczeń eventHubConsumerClient.

Właściwości dziedziczone

customEndpointAddress

Niestandardowy punkt końcowy używany podczas nawiązywania połączenia z usługą Event Hubs. Może to być przydatne, gdy sieć nie zezwala na nawiązywanie połączenia ze standardowym adresem punktu końcowego usługi Azure Event Hubs, ale umożliwia nawiązywanie połączenia za pośrednictwem pośrednika.

Przykład: "https://my.custom.endpoint:100/"
identifier

Unikatowa nazwa używana do identyfikowania klienta. Jeśli nie zostanie podany, identyfikator GUID będzie używany jako identyfikator
retryOptions

Opcje konfigurowania zasad ponawiania dla wszystkich operacji na kliencie. Na przykład { "maxRetries": 4 } lub { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Wartość dołączona do wbudowanego ciągu agenta użytkownika przekazanego do usługi Event Hubs.
webSocketOptions

Opcje konfigurowania kanału połączenia AMQP za pośrednictwem gniazd sieci Web.

Szczegóły właściwości

loadBalancingOptions

Opcje dostrajania sposobu partycjonowania oświadczeń eventHubConsumerClient.

loadBalancingOptions?: LoadBalancingOptions

Wartość właściwości

LoadBalancingOptions

Szczegóły właściwości dziedziczonej

customEndpointAddress

Niestandardowy punkt końcowy używany podczas nawiązywania połączenia z usługą Event Hubs. Może to być przydatne, gdy sieć nie zezwala na nawiązywanie połączenia ze standardowym adresem punktu końcowego usługi Azure Event Hubs, ale umożliwia nawiązywanie połączenia za pośrednictwem pośrednika.

Przykład: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

Wartość właściwości

string

dziedziczone zEventHubClientOptions.customEndpointAddress

identifier

Unikatowa nazwa używana do identyfikowania klienta. Jeśli nie zostanie podany, identyfikator GUID będzie używany jako identyfikator

identifier?: string

Wartość właściwości

string

dziedziczone zEventHubClientOptions.identifier

retryOptions

Opcje konfigurowania zasad ponawiania dla wszystkich operacji na kliencie. Na przykład { "maxRetries": 4 } lub { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Wartość właściwości

RetryOptions

dziedziczone zEventHubClientOptions.retryOptions

userAgent

Wartość dołączona do wbudowanego ciągu agenta użytkownika przekazanego do usługi Event Hubs.

userAgent?: string

Wartość właściwości

string

dziedziczone zEventHubClientOptions.userAgent

webSocketOptions

Opcje konfigurowania kanału połączenia AMQP za pośrednictwem gniazd sieci Web.

webSocketOptions?: WebSocketOptions

Wartość właściwości

WebSocketOptions

dziedziczone zEventHubClientOptions.webSocketOptions