ServiceBusClientOptions interface

Pacote:

@azure/service-bus

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

• 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.
  • maxRetries : o número de vezes que a operação pode ser repetida em caso de erro reativado.
  • maxRetryDelayInMs: o atraso máximo entre repetições. Aplicável apenas quando efetuar repetições exponenciais.
  • mode: o modo de repetição a aplicar, especificado pela enumeração RetryMode . As opções são Exponential e Fixed. A predefinição é Fixed.
  • retryDelayInMs: quantidade de tempo a 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: quantidade de tempo em milissegundos a aguardar antes de a operação exceder o limite de tempo. Esta ação irá acionar uma repetição se existirem tentativas de repetição restantes. Valor mínimo: 60 000 milissegundos.

Propriedades

customEndpointAddress	Um ponto final personalizado a utilizar ao ligar ao serviço Service Bus. Isto pode ser útil quando a sua rede não permite a ligação ao endereço de ponto final padrão Azure Service Bus, mas permite a ligação através de um intermediário. Exemplo: "https://my.custom.endpoint:100/"
identifier	ID para identificar este cliente. Isto pode ser utilizado para correlacionar registos e exceções.
retryOptions	Repita as opções de política que determinam o modo, o número de repetições, o intervalo de repetição, etc.
userAgentOptions	Opções para adicionar detalhes do agente de utilizador aos pedidos enviados.
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 Service Bus. Isto pode ser útil quando a sua rede não permite a ligação ao endereço de ponto final padrão Azure Service Bus, mas permite a ligação através de um intermediário.

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

customEndpointAddress?: string

Valor de Propriedade

string

identifier

ID para identificar este cliente. Isto pode ser utilizado para correlacionar registos e exceções.

identifier?: string

Valor de Propriedade

string

retryOptions

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

retryOptions?: RetryOptions

Valor de Propriedade

RetryOptions

userAgentOptions

Opções para adicionar detalhes do agente de utilizador aos pedidos enviados.

userAgentOptions?: UserAgentPolicyOptions

Valor de Propriedade

UserAgentPolicyOptions

webSocketOptions

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

webSocketOptions?: WebSocketOptions

Valor de Propriedade

WebSocketOptions