ServiceBusClientOptions interface

  • Odwołanie
Pakiet:
@azure/service-bus

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

  • 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.
    • 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, 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 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ść minimalna: 60000 milisekund.

Właściwości

customEndpointAddress

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

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

Identyfikator identyfikującego tego klienta. Może to służyć do korelowania dzienników i wyjątków.
retryOptions

Opcje zasad ponawiania, które określają tryb, liczbę ponownych prób, interwał ponawiania prób itp.
userAgentOptions

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.
webSocketOptions

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

Szczegóły właściwości

customEndpointAddress

Niestandardowy punkt końcowy używany podczas nawiązywania połączenia z usługą Service Bus. Może to być przydatne, gdy sieć nie zezwala na nawiązywanie połączenia ze standardowym adresem punktu końcowego Azure Service Bus, 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

Identyfikator identyfikującego tego klienta. Może to służyć do korelowania dzienników i wyjątków.

identifier?: string

Wartość właściwości

string

retryOptions

Opcje zasad ponawiania, które określają tryb, liczbę ponownych prób, interwał ponawiania prób itp.

retryOptions?: RetryOptions

Wartość właściwości

RetryOptions

userAgentOptions

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

userAgentOptions?: UserAgentPolicyOptions

Wartość właściwości

UserAgentPolicyOptions

webSocketOptions

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

webSocketOptions?: WebSocketOptions

Wartość właściwości

WebSocketOptions