Udostępnij za pośrednictwem

EventHubConsumerClientOptions interface

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

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

  • loadBalancingOptions: opcje dostrojenia partycji oświadczeń EventHubConsumerClient.
  • userAgent : ciąg dołączany do wbudowanych parametrów agenta użytkownika, który jest przekazywany jako właściwość połączenia do usługi.
  • 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 : ile razy można ponowić próbę operacji w przypadku błędu możliwego do ponowienia próby.
    • maxRetryDelayInMs: maksymalne opóźnienie między ponawianiami prób. Ma zastosowanie tylko w przypadku wykonywania ponownych prób wykładniczych.
    • mode: który tryb ponawiania prób ma być stosowany 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 parametr ma wartość 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 upływem limitu czasu operacji. Spowoduje to wyzwolenie ponawiania próby w przypadku pozostałych ponownych prób. Wartość domyślna: 60000 milisekund.

Prostym użyciem może być { "maxRetries": 4 }.

Przykład użycia: 

{
    retryOptions: {
        maxRetries: 4
    }
}
Rozszerzenie
EventHubClientOptions

Właściwości

loadBalancingOptions

Opcje dostrajania partycji 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 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 przekazywanego 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 partycji 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 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 zelementu EventHubClientOptions.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 zelementu EventHubClientOptions.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 zelementu EventHubClientOptions.retryOptions

userAgent

Wartość dołączona do wbudowanego ciągu agenta użytkownika przekazywanego 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 zelementu EventHubClientOptions.webSocketOptions