EventHubClientOptions interface

Pacote:

@azure/event-hubs

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

• userAgent : Uma cadeia de caracteres para acrescentar à cadeia de caracteres do agente do usuário interna que é passada como uma propriedade de conexão para o serviço.
• webSocketOptions : Opções para configurar a canalização da conexão AMQP através de Web Sockets.
  • websocket : O construtor WebSocket usado para criar uma conexão AMQP se você optar por fazer a conexão através de um WebSocket.
  • webSocketConstructorOptions : Opções para passar para o construtor Websocket quando você optar por fazer a conexã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 um erro tentável.
  • maxRetryDelayInMs: O atraso máximo entre as tentativas. Aplicável apenas ao realizar tentativas exponenciais.
  • mode: Qual modo de repetição aplicar, especificado pelo RetryMode enum. As opções são Exponential e Fixed. O padrão é Fixed.
  • retryDelayInMs: Quantidade de tempo para esperar em milissegundos antes de fazer a próxima tentativa. Quando mode é definido como Exponential, isso é usado para calcular os atrasos exponencialmente crescentes entre as tentativas. Padrão: 30000 milissegundos.
  • timeoutInMs: Quantidade de tempo em milissegundos para aguardar antes que a operação atinja o tempo limite. Isso acionará uma nova tentativa se houver alguma tentativa restante. Valor padrão: 60000 milissegundos.

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

Exemplo de uso:

{
    retryOptions: {
        maxRetries: 4
    }
}

Propriedades

customEndpointAddress	Um ponto de extremidade personalizado para usar ao se conectar ao serviço Hubs de Eventos. Isso pode ser útil quando sua rede não permite a conexão com o 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 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 é anexado à cadeia de caracteres interna do agente do usuário que é passada para o serviço Hubs de Eventos.
webSocketOptions	Opções para configurar a canalização da conexão AMQP através de Web Sockets.

Detalhes de Propriedade

customEndpointAddress

Um ponto de extremidade personalizado para usar ao se conectar ao serviço Hubs de Eventos. Isso pode ser útil quando sua rede não permite a conexão com o 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 de Propriedade

string

identifier

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

identifier?: string

Valor de Propriedade

string

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

userAgent

Valor que é anexado à cadeia de caracteres interna do agente do usuário que é passada para o serviço Hubs de Eventos.

userAgent?: string

Valor de Propriedade

string

webSocketOptions

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

webSocketOptions?: WebSocketOptions

Valor de Propriedade

WebSocketOptions