Udostępnij za pośrednictwem

EventHubClientOptions interface

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

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

  • userAgent : ciąg dołączany do wbudowanych parametrów agenta użytkownika, które są przekazywane jako właściwość połączenia z usługą.
  • webSocketOptions : Opcje konfigurowania kanału połączenia AMQP za pośrednictwem gniazd internetowych.
    • websocket : Konstruktor protokołu WebSocket używany do tworzenia połączenia AMQP, jeśli zdecydujesz się na 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 wszystkich operacji na kliencie/producencie/odbiorcy.
    • maxRetries : liczba ponownych prób operacji może zostać ponowiona w przypadku błędu możliwego do ponowienia próby.
    • maxRetryDelayInMs: maksymalne opóźnienie między ponawianiami prób. Dotyczy tylko w przypadku ponawiania prób wykładniczych.
    • mode: który tryb ponawiania prób 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 Exponentialwartość , 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 prób ponawiania prób. Wartość domyślna: 60000 milisekund.

Proste użycie może być następujące: { "maxRetries": 4 }.

Przykład użycia: 

{
    retryOptions: {
        maxRetries: 4
    }
}

Właściwości

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 przekazanego do usługi Event Hubs.
webSocketOptions

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

Szczegóły właściwości

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

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

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

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

webSocketOptions

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

webSocketOptions?: WebSocketOptions

Wartość właściwości

WebSocketOptions