EventHubConsumerClientOptions interface

Pacote:

@azure/event-hubs

Descreve as opções que podem ser fornecidas ao criar o EventHubConsumerClient.

• loadBalancingOptions: opções para ajustar a forma como o EventHubConsumerClient afirma partições.
• userAgent : uma cadeia para acrescentar à cadeia de agente de utilizador incorporada que é transmitida como uma propriedade de ligação ao serviço.
• webSocketOptions : opções para configurar a canalização da ligação AMQP através de Sockets Web.
  • websocket : o construtor WebSocket utilizado para criar uma ligação AMQP se optar por fazer a ligação através de um WebSocket.
  • webSocketConstructorOptions : opções para passar para o construtor Websocket quando optar por fazer a ligação através de um WebSocket.
• retryOptions : as opções de repetição para todas as operações no cliente/produtor/consumidor.
  • maxRetries : o número de vezes que a operação pode ser repetida em caso de erro reativado.
  • maxRetryDelayInMs: o atraso máximo entre repetições. Aplicável apenas quando efetuar repetições exponenciais.
  • mode: o modo de repetição a aplicar, especificado pela enumeração RetryMode . As opções são Exponential e Fixed. A predefinição é Fixed.
  • retryDelayInMs: quantidade de tempo a aguardar em milissegundos antes de fazer a próxima tentativa. Quando mode está definido como Exponential, isto é utilizado para calcular os atrasos exponencialmente crescentes entre repetições. Predefinição: 30000 milissegundos.
  • timeoutInMs: quantidade de tempo em milissegundos a aguardar antes de a operação exceder o limite de tempo. Esta ação irá acionar uma repetição se existirem tentativas de repetição restantes. Valor predefinido: 60 000 milissegundos.

Uma utilização simples pode ser { "maxRetries": 4 }.

Utilização de exemplo:

{
    retryOptions: {
        maxRetries: 4
    }
}

Extends

EventHubClientOptions

Propriedades

loadBalancingOptions

Opções para ajustar a forma como o EventHubConsumerClient afirma partições.

Propriedades Herdadas

customEndpointAddress	Um ponto final personalizado a utilizar ao ligar ao serviço Dos Hubs de Eventos. Isto pode ser útil quando a sua rede não permite a ligação ao endereço de ponto final padrão Hubs de Eventos do Azure, mas permite a ligação através de um intermediário. Exemplo: "https://my.custom.endpoint:100/"
identifier	Um nome exclusivo utilizado para identificar o cliente. Se não for fornecido, será utilizado um GUID como identificador
retryOptions	Opções para configurar a política de repetição para todas as operações no cliente. Por exemplo, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent	Valor que é acrescentado à cadeia de agente de utilizador incorporada que é transmitida ao serviço Hubs de Eventos.
webSocketOptions	Opções para configurar a canalização da ligação AMQP através de Sockets Web.

Detalhes de Propriedade

loadBalancingOptions

Opções para ajustar a forma como o EventHubConsumerClient afirma partições.

loadBalancingOptions?: LoadBalancingOptions

Valor de Propriedade

LoadBalancingOptions

Detalhes da Propriedade Herdada

customEndpointAddress

Um ponto final personalizado a utilizar ao ligar ao serviço Dos Hubs de Eventos. Isto pode ser útil quando a sua rede não permite a ligação ao endereço de ponto final padrão Hubs de Eventos do Azure, mas permite a ligação através de um intermediário.

Exemplo: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

Valor de Propriedade

string

Herdado deEventHubClientOptions.customEndpointAddress

identifier

Um nome exclusivo utilizado para identificar o cliente. Se não for fornecido, será utilizado um GUID como identificador

identifier?: string

Valor de Propriedade

string

Herdado deEventHubClientOptions.identifier

retryOptions

Opções para configurar a política de repetição para todas as operações no cliente. Por exemplo, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Valor de Propriedade

RetryOptions

Herdado deEventHubClientOptions.retryOptions

userAgent

Valor que é acrescentado à cadeia de agente de utilizador incorporada que é transmitida ao serviço Hubs de Eventos.

userAgent?: string

Valor de Propriedade

string

Herdado deEventHubClientOptions.userAgent

webSocketOptions

Opções para configurar a canalização da ligação AMQP através de Sockets Web.

webSocketOptions?: WebSocketOptions

Valor de Propriedade

WebSocketOptions

Herdado deEventHubClientOptions.webSocketOptions