EventHubConsumerClientOptions interface

  • Ссылка
Пакет:
@azure/event-hubs

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

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

Простым способом использования может быть { "maxRetries": 4 }.

Пример использования:

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends
EventHubClientOptions

Свойства

loadBalancingOptions

Параметры для настройки секционирования утверждений EventHubConsumerClient.

Унаследованные свойства

customEndpointAddress

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

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

Уникальное имя, используемое для идентификации клиента. Если этот идентификатор не указан, в качестве идентификатора будет использоваться GUID.
retryOptions

Параметры для настройки политики повторных попыток для всех операций на клиенте. Например, { "maxRetries": 4 } или { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Значение, добавляемое к встроенной строке агента пользователя, передаваемой в службу Центров событий.
webSocketOptions

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

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

loadBalancingOptions

Параметры для настройки секционирования утверждений EventHubConsumerClient.

loadBalancingOptions?: LoadBalancingOptions

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

LoadBalancingOptions

Сведения об унаследованном свойстве

customEndpointAddress

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

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

customEndpointAddress?: string

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

string

Наследуется отEventHubClientOptions.customEndpointAddress

identifier

Уникальное имя, используемое для идентификации клиента. Если этот идентификатор не указан, в качестве идентификатора будет использоваться GUID.

identifier?: string

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

string

Наследуется отEventHubClientOptions.identifier

retryOptions

Параметры для настройки политики повторных попыток для всех операций на клиенте. Например, { "maxRetries": 4 } или { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

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

RetryOptions

Наследуется отEventHubClientOptions.retryOptions

userAgent

Значение, добавляемое к встроенной строке агента пользователя, передаваемой в службу Центров событий.

userAgent?: string

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

string

Наследуется отEventHubClientOptions.userAgent

webSocketOptions

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

webSocketOptions?: WebSocketOptions

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

WebSocketOptions

Наследуется отEventHubClientOptions.webSocketOptions