Поделиться через

EventHubClientOptions interface

Пакет:
@azure/event-hubs

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

  • 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
    }
}

Свойства

customEndpointAddress

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

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

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

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

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

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

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

customEndpointAddress

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

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

customEndpointAddress?: string

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

string

identifier

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

identifier?: string

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

string

retryOptions

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

retryOptions?: RetryOptions

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

RetryOptions

userAgent

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

userAgent?: string

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

string

webSocketOptions

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

webSocketOptions?: WebSocketOptions

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

WebSocketOptions