EventHubConsumerClientOptions interface
Descreve as opções que podem ser fornecidas ao criar o 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 o canal da conexão AMQP por meio de Web Sockets.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 em caso de um erro repetível.maxRetryDelayInMs
: o atraso máximo entre as repetições. Aplicável somente ao executar novas tentativas exponencial.mode
: qual modo de repetição aplicar, especificado pelaRetryMode
enumeração . As opções sãoExponential
eFixed
. Assume o padrão deFixed
.retryDelayInMs
: tempo de espera em milissegundos antes de fazer a próxima tentativa. Quandomode
é definidoExponential
como , isso é usado para calcular os atrasos exponencialmente crescentes entre as repetições. Padrão: 30000 milissegundos.timeoutInMs
: quantidade de tempo em milissegundos para aguardar antes que a operação expirar. Isso disparará uma nova tentativa se houver outras tentativas restantes. Valor padrão: 60000 milissegundos.
Um uso simples pode ser { "maxRetries": 4 }
.
Exemplo de uso:
{
retryOptions: {
maxRetries: 4
}
}
- Extends
Propriedades
load |
Opções para ajustar como o EventHubConsumerClient declara partições. |
Propriedades herdadas
custom |
Um ponto de extremidade personalizado a ser usado ao se conectar ao serviço de Hubs de Eventos. Isso pode ser útil quando sua rede não permite a conexão com o endereço padrão do ponto de extremidade 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 |
retry |
Opções para configurar a política de repetição para todas as operações no cliente.
Por exemplo, |
user |
Valor que é acrescentado à cadeia de caracteres interna do agente de usuário que é passada para o serviço hubs de eventos. |
web |
Opções para configurar o canal da conexão AMQP por meio de Web Sockets. |
Detalhes da propriedade
loadBalancingOptions
Opções para ajustar como o EventHubConsumerClient declara partições.
loadBalancingOptions?: LoadBalancingOptions
Valor da propriedade
Detalhes das propriedades herdadas
customEndpointAddress
Um ponto de extremidade personalizado a ser usado ao se conectar ao serviço de Hubs de Eventos. Isso pode ser útil quando sua rede não permite a conexão com o endereço padrão do ponto de extremidade 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
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
Herdado deEventHubClientOptions.retryOptions
userAgent
Valor que é 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 o canal da conexão AMQP por meio de Web Sockets.
webSocketOptions?: WebSocketOptions
Valor da propriedade
Herdado deEventHubClientOptions.webSocketOptions