ServiceBusClientOptions interface

  • Referencia
Paquete:
@azure/service-bus

Describe las opciones que se pueden proporcionar al crear ServiceBusClient.

  • 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 del cliente.
    • 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. Su valor predeterminado es 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 mínimo: 60000 milisegundos.

Propiedades

customEndpointAddress

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

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

Identificador para identificar este cliente. Esto se puede usar para correlacionar registros y excepciones.
retryOptions

Opciones de directiva de reintento que determinan el modo, el número de reintentos, el intervalo de reintento, etc.
userAgentOptions

Opciones para agregar detalles del agente de usuario a las solicitudes salientes.
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 Service Bus. Esto puede ser útil cuando la red no permite conectarse a la dirección de punto de conexión de Azure Service Bus estándar, pero permite conectarse a través de un intermediario.

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

customEndpointAddress?: string

Valor de propiedad

string

identifier

Identificador para identificar este cliente. Esto se puede usar para correlacionar registros y excepciones.

identifier?: string

Valor de propiedad

string

retryOptions

Opciones de directiva de reintento que determinan el modo, el número de reintentos, el intervalo de reintento, etc.

retryOptions?: RetryOptions

Valor de propiedad

RetryOptions

userAgentOptions

Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

userAgentOptions?: UserAgentPolicyOptions

Valor de propiedad

UserAgentPolicyOptions

webSocketOptions

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

webSocketOptions?: WebSocketOptions

Valor de propiedad

WebSocketOptions