ServiceBusClientOptions interface

  • Ссылка
Пакет:
@azure/service-bus

Описание параметров, которые можно предоставить при создании ServiceBusClient.

  • webSocketOptions : параметры для настройки канала подключения AMQP через веб-сокеты.
    • websocket : конструктор WebSocket, используемый для создания подключения AMQP, если вы решили установить подключение через WebSocket.
    • webSocketConstructorOptions : параметры для передачи в конструктор Websocket при выборе подключения через WebSocket.
  • retryOptions : параметры повтора для всех операций на клиенте.
    • maxRetries : количество повторных попыток выполнения операции в случае ошибки, допускаемой повторно.
    • maxRetryDelayInMs: максимальная задержка между повторными попытками. Применимо только при выполнении экспоненциальных повторных попыток.
    • mode: применяемый режим повторных попыток, заданный перечислением RetryMode . Возможные значения: Exponential и Fixed. По умолчанию — Fixed.
    • retryDelayInMs: время ожидания в миллисекундах перед выполнением следующей попытки. Если mode для задано значение Exponential, это используется для вычисления экспоненциально увеличивающихся задержек между повторными попытками. Значение по умолчанию: 30000 миллисекундах.
    • timeoutInMs: время ожидания в миллисекундах до истечения времени ожидания операции. Это активирует повторную попытку, если еще есть какие-либо повторные попытки. Минимальное значение: 60 000 миллисекунда.

Свойства

customEndpointAddress

Пользовательская конечная точка, используемая при подключении к службе служебной шины. Это может быть полезно, если сеть не разрешает подключение к стандартному адресу конечной точки Служебная шина Azure, но разрешает подключение через посредника.

Пример: "https://my.custom.endpoint:100/"
identifier

Идентификатор для идентификации этого клиента. Его можно использовать для корреляции журналов и исключений.
retryOptions

Параметры политики повтора, определяющие режим, количество повторных попыток, интервал повтора и т. д.
userAgentOptions

Параметры добавления сведений об агенте пользователя в исходящие запросы.
webSocketOptions

Параметры для настройки канала подключения AMQP через веб-сокеты.

Сведения о свойстве

customEndpointAddress

Пользовательская конечная точка, используемая при подключении к службе служебной шины. Это может быть полезно, если сеть не разрешает подключение к стандартному адресу конечной точки Служебная шина Azure, но разрешает подключение через посредника.

Пример: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

Значение свойства

string

identifier

Идентификатор для идентификации этого клиента. Его можно использовать для корреляции журналов и исключений.

identifier?: string

Значение свойства

string

retryOptions

Параметры политики повтора, определяющие режим, количество повторных попыток, интервал повтора и т. д.

retryOptions?: RetryOptions

Значение свойства

RetryOptions

userAgentOptions

Параметры добавления сведений об агенте пользователя в исходящие запросы.

userAgentOptions?: UserAgentPolicyOptions

Значение свойства

UserAgentPolicyOptions

webSocketOptions

Параметры для настройки канала подключения AMQP через веб-сокеты.

webSocketOptions?: WebSocketOptions

Значение свойства

WebSocketOptions