Partilhar via

EventHubClientOptions interface

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

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

  • 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 retráctil.
    • maxRetryDelayInMs: o atraso máximo entre as repetições. Aplicável apenas ao realizar repetições exponenciais.
    • mode: o modo de repetição a aplicar, especificado pela RetryMode enum. As opções são Exponential e Fixed. Predefinições para Fixed.
    • retryDelayInMs: período de tempo para 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: período de tempo em milissegundos para aguardar antes de a operação exceder o limite de tempo. Isto irá acionar uma repetição se existirem tentativas de repetição restantes. Valor predefinido: 60000 milissegundos.

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

Utilização de exemplo: 

{
    retryOptions: {
        maxRetries: 4
    }
}

Propriedades

customEndpointAddress

Um ponto final personalizado a utilizar ao ligar ao serviço 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 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

customEndpointAddress

Um ponto final personalizado a utilizar ao ligar ao serviço 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

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

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 acrescentado à cadeia de agente de utilizador incorporada que é transmitida ao serviço Hubs de Eventos.

userAgent?: string

Valor de Propriedade

string

webSocketOptions

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

webSocketOptions?: WebSocketOptions

Valor de Propriedade

WebSocketOptions