你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

ServiceBusClientOptions interface

介绍创建 ServiceBusClient 时可以提供的选项。

  • webSocketOptions :用于配置通过 Web 套接字的 AMQP 连接的通道的选项。
    • websocket :如果选择通过 WebSocket 建立连接,则为用于创建 AMQP 连接的 WebSocket 构造函数。
    • webSocketConstructorOptions :选择通过 WebSocket 建立连接时传递给 Websocket 构造函数的选项。
  • retryOptions :客户端上所有操作的重试选项。
    • maxRetries :发生可重试错误时可以重试操作的次数。
    • maxRetryDelayInMs:重试之间的最大延迟。 仅当执行指数重试时才适用。
    • mode:要应用的重试模式,由 RetryMode 枚举指定。 选项包括 ExponentialFixed。 默认为 Fixed
    • retryDelayInMs:下一次尝试之前等待的时间(以毫秒为单位)。 当 设置为 Exponentialmode,这用于计算两次重试之间呈指数级增长的延迟。 默认值:30000 毫秒。
    • timeoutInMs:操作超时前等待的时间(以毫秒为单位)。如果剩余任何重试尝试,这将触发重试。 最小值:60000 毫秒。

属性

customEndpointAddress

连接到服务总线服务时要使用的自定义终结点。 当网络不允许连接到标准Azure 服务总线终结点地址,但允许通过中介进行连接时,这非常有用。

示例:“https://my.custom.endpoint:100/"

identifier

用于标识此客户端的 ID。 这可用于关联日志和异常。

retryOptions

用于确定模式、重试次数、重试间隔等的重试策略选项。

userAgentOptions

用于将用户代理详细信息添加到传出请求的选项。

webSocketOptions

用于通过 Web 套接字配置 AMQP 连接的通道的选项。

属性详细信息

customEndpointAddress

连接到服务总线服务时要使用的自定义终结点。 当网络不允许连接到标准Azure 服务总线终结点地址,但允许通过中介进行连接时,这非常有用。

示例:“https://my.custom.endpoint:100/"

customEndpointAddress?: string

属性值

string

identifier

用于标识此客户端的 ID。 这可用于关联日志和异常。

identifier?: string

属性值

string

retryOptions

用于确定模式、重试次数、重试间隔等的重试策略选项。

retryOptions?: RetryOptions

属性值

userAgentOptions

用于将用户代理详细信息添加到传出请求的选项。

userAgentOptions?: UserAgentPolicyOptions

属性值

webSocketOptions

用于通过 Web 套接字配置 AMQP 连接的通道的选项。

webSocketOptions?: WebSocketOptions

属性值