Compartir a través de

EventHubClientOptions interface

  • Referencia
Paquete:
@azure/event-hubs

Describe las opciones que se pueden proporcionar al crear EventHubClient.

  • userAgent : cadena que se va a anexar a la cadena del agente de usuario integrada que se pasa como una propiedad de conexión al servicio.
  • webSocketOptions : opciones para configurar el canalización de la conexión AMQP a través de web Sockets.
    • websocket : el constructor WebSocket que se usa para crear una conexión AMQP si decide establecer la conexión a través de un WebSocket.
    • webSocketConstructorOptions : opciones para pasar al constructor Websocket al elegir establecer la conexión a través de un WebSocket.
  • retryOptions : las opciones de reintento para todas las operaciones en el cliente, productor o consumidor.
    • maxRetries : número de veces que se puede reintentar la operación en caso de un error que se pueda reintentar.
    • maxRetryDelayInMs: retraso máximo entre reintentos. Solo es aplicable al realizar reintentos exponenciales.
    • mode: el modo de reintento que se va a aplicar, especificado por la RetryMode enumeración. Las opciones son Exponential y Fixed. Tiene como valor predeterminado Fixed.
    • retryDelayInMs: cantidad de tiempo de espera en milisegundos antes de realizar el siguiente intento. Cuando mode se establece Exponentialen , se usa para calcular los retrasos crecientes exponencialmente entre reintentos. Valor predeterminado: 30000 milisegundos.
    • timeoutInMs: cantidad de tiempo en milisegundos que se esperarán antes de que se agote el tiempo de espera de la operación. Esto desencadenará un reintento si quedan intentos de reintento. Valor predeterminado: 60000 milisegundos.

Un uso simple puede ser { "maxRetries": 4 }.

Ejemplo de uso:

{
    retryOptions: {
        maxRetries: 4
    }
}

Propiedades

customEndpointAddress

Un punto de conexión personalizado que se usará al conectarse al servicio Event Hubs. Esto puede ser útil cuando la red no permite conectarse a la dirección del punto de conexión de Azure Event Hubs estándar, pero permite conectarse a través de un intermediario.

Por ejemplo: "https://my.custom.endpoint:100/"
identifier

Un nombre único que se usa para identificar al cliente. Si no se proporciona, se usará un GUID como identificador.
retryOptions

Opciones para configurar la directiva de reintentos para todas las operaciones del cliente. Por ejemplo, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Valor que se anexa a la cadena del agente de usuario integrada que se pasa al servicio Event Hubs.
webSocketOptions

Opciones para configurar el canalización de la conexión AMQP a través de web Sockets.

Detalles de las propiedades

customEndpointAddress

Un punto de conexión personalizado que se usará al conectarse al servicio Event Hubs. Esto puede ser útil cuando la red no permite conectarse a la dirección del punto de conexión de Azure Event Hubs estándar, pero permite conectarse a través de un intermediario.

Por ejemplo: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

Valor de propiedad

string

identifier

Un nombre único que se usa para identificar al cliente. Si no se proporciona, se usará un GUID como identificador.

identifier?: string

Valor de propiedad

string

retryOptions

Opciones para configurar la directiva de reintentos para todas las operaciones del cliente. Por ejemplo, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Valor de propiedad

RetryOptions

userAgent

Valor que se anexa a la cadena del agente de usuario integrada que se pasa al servicio Event Hubs.

userAgent?: string

Valor de propiedad

string

webSocketOptions

Opciones para configurar el canalización de la conexión AMQP a través de web Sockets.

webSocketOptions?: WebSocketOptions

Valor de propiedad

WebSocketOptions