Compartilhar via

EventHubConsumerClientOptions interface

  • Referência
Pacote:
@azure/event-hubs

Descreve as opções que podem ser fornecidas durante a criação do EventHubConsumerClient.

  • loadBalancingOptions: opções para ajustar como o EventHubConsumerClient declara partições.
  • userAgent: uma cadeia de caracteres a ser acrescentada à cadeia de caracteres interna do agente de usuário que é passada como uma propriedade de conexão para o serviço.
  • webSocketOptions: opções para configurar a canalização da conexão AMQP por meio de Soquetes Web.
    • websocket: o construtor WebSocket usado para criar uma conexão AMQP se você optar por fazer a conexão em um WebSocket.
    • webSocketConstructorOptions: opções para passar para o construtor Websocket quando você optar por fazer a conexão em 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 no caso de um erro retrátivel.
    • maxRetryDelayInMs: o atraso máximo entre novas tentativas. Aplicável somente ao executar novas tentativas exponencial.
    • mode: qual modo de repetição aplicar, especificado pela enumeração RetryMode. As opções são Exponential e Fixed. O padrão é Fixed.
    • retryDelayInMs: tempo de espera em milissegundos antes de fazer a próxima tentativa. Quando mode é definido como Exponential, isso é usado para calcular os atrasos exponencialmente crescentes entre repetições. Padrão: 30000 milissegundos.
    • timeoutInMs: quantidade de tempo em milissegundos para aguardar antes do tempo limite da operação. Isso disparará uma nova tentativa se houver outras tentativas restantes. Valor padrão: 60000 milissegundos.

Um uso simples pode ser { "maxRetries": 4 }.

Uso de exemplo:

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends
EventHubClientOptions

Propriedades

loadBalancingOptions

Opções para ajustar como o EventHubConsumerClient declara partições.

Propriedades herdadas

customEndpointAddress

Um ponto de extremidade personalizado a ser usado ao se conectar ao serviço hubs de eventos. Isso pode ser útil quando sua rede não permite se conectar ao endereço de ponto de extremidade padrão dos Hubs de Eventos do Azure, mas permite a conexão por meio de um intermediário.

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

Um nome exclusivo usado para identificar o cliente. Se não for fornecido, um GUID será usado como o 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 acrescentado à cadeia de caracteres interna do agente de usuário que é passada para o serviço hubs de eventos.
webSocketOptions

Opções para configurar a canalização da conexão AMQP por meio de Soquetes Web.

Detalhes da propriedade

loadBalancingOptions

Opções para ajustar como o EventHubConsumerClient declara partições.

loadBalancingOptions?: LoadBalancingOptions

Valor da propriedade

LoadBalancingOptions

Detalhes das propriedades herdadas

customEndpointAddress

Um ponto de extremidade personalizado a ser usado ao se conectar ao serviço hubs de eventos. Isso pode ser útil quando sua rede não permite se conectar ao endereço de ponto de extremidade padrão dos Hubs de Eventos do Azure, mas permite a conexão por meio de um intermediário.

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

customEndpointAddress?: string

Valor da propriedade

string

herdado deEventHubClientOptions.customEndpointAddress

identifier

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

identifier?: string

Valor da 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 da propriedade

RetryOptions

herdado deeventHubClientOptions.retryOptions

userAgent

Valor acrescentado à cadeia de caracteres interna do agente de usuário que é passada para o serviço hubs de eventos.

userAgent?: string

Valor da propriedade

string

herdado deEventHubClientOptions.userAgent

webSocketOptions

Opções para configurar a canalização da conexão AMQP por meio de Soquetes Web.

webSocketOptions?: WebSocketOptions

Valor da propriedade

WebSocketOptions

herdado deEventHubClientOptions.webSocketOptions