Partilhar via

ServiceBusClientOptions interface

  • Referência
Pacote:
@azure/service-bus

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

  • 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.
    • 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 mínimo: 60000 milissegundos.

Propriedades

customEndpointAddress

Um ponto de extremidade personalizado para usar ao se conectar ao serviço do Service Bus. Isso pode ser útil quando sua rede não permite a conexão com o endereço de ponto de extremidade padrão do Barramento de Serviço do Azure, mas permite a conexão por meio de um intermediário.

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

ID para identificar este cliente. Isso pode ser usado para correlacionar logs e exceções.
retryOptions

Opções de política de repetição que determinam o modo, o número de tentativas, o intervalo de repetição etc.
userAgentOptions

Opções para adicionar detalhes do agente do usuário às solicitações de saída.
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 do Service Bus. Isso pode ser útil quando sua rede não permite a conexão com o endereço de ponto de extremidade padrão do Barramento de Serviço 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

ID para identificar este cliente. Isso pode ser usado para correlacionar logs e exceções.

identifier?: string

Valor de Propriedade

string

retryOptions

Opções de política de repetição que determinam o modo, o número de tentativas, o intervalo de repetição etc.

retryOptions?: RetryOptions

Valor de Propriedade

RetryOptions

userAgentOptions

Opções para adicionar detalhes do agente do usuário às solicitações de saída.

userAgentOptions?: UserAgentPolicyOptions

Valor de Propriedade

UserAgentPolicyOptions

webSocketOptions

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

webSocketOptions?: WebSocketOptions

Valor de Propriedade

WebSocketOptions