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

EventHubConsumerClientOptions interface

  • 参考
包:
@azure/event-hubs

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

  • loadBalancingOptions：用于优化 EventHubConsumerClient 声明分区方式的选项。
  • userAgent ：要追加到作为连接属性传递给服务的内置用户代理字符串的字符串。
  • webSocketOptions ：用于配置通过 Web 套接字的 AMQP 连接的通道的选项。
    • websocket ：如果选择通过 WebSocket 建立连接，则为用于创建 AMQP 连接的 WebSocket 构造函数。
    • webSocketConstructorOptions ：选择通过 WebSocket 建立连接时传递给 Websocket 构造函数的选项。
  • retryOptions ：客户端/生成者/使用者上所有操作的重试选项。
    • maxRetries ：发生可重试错误时可以重试操作的次数。
    • maxRetryDelayInMs：重试之间的最大延迟。 仅当执行指数重试时才适用。
    • mode：要应用的重试模式，由 RetryMode 枚举指定。 选项包括 Exponential 和 Fixed。 默认为 Fixed。
    • retryDelayInMs：下一次尝试之前等待的时间（以毫秒为单位）。 当 设置为 Exponential时mode，这用于计算两次重试之间呈指数级增长的延迟。 默认值：30000 毫秒。
    • timeoutInMs：操作超时前等待的时间（以毫秒为单位）。如果剩余任何重试尝试，这将触发重试。 默认值：60000 毫秒。

简单用法可以是 { "maxRetries": 4 }。

用法示例：

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends
EventHubClientOptions

属性

loadBalancingOptions

用于优化 EventHubConsumerClient 声明分区方式的选项。

继承属性

customEndpointAddress

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

示例："https://my.custom.endpoint:100/"
identifier

用于标识客户端的唯一名称。 如果未提供，GUID 将用作标识符
retryOptions

用于为客户端上的所有操作配置重试策略的选项。 例如 { "maxRetries": 4 } 或 { "maxRetries": 4, "retryDelayInMs": 30000 }。
userAgent

追加到传递给事件中心服务的内置用户代理字符串的值。
webSocketOptions

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

属性详细信息

loadBalancingOptions

用于优化 EventHubConsumerClient 声明分区方式的选项。

loadBalancingOptions?: LoadBalancingOptions

属性值

LoadBalancingOptions

继承属性详细信息

customEndpointAddress

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

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

customEndpointAddress?: string

属性值

string

继承自EventHubClientOptions.customEndpointAddress

identifier

用于标识客户端的唯一名称。 如果未提供，GUID 将用作标识符

identifier?: string

属性值

string

继承自EventHubClientOptions.identifier

retryOptions

用于为客户端上的所有操作配置重试策略的选项。 例如 { "maxRetries": 4 } 或 { "maxRetries": 4, "retryDelayInMs": 30000 }。

retryOptions?: RetryOptions

属性值

RetryOptions

继承自EventHubClientOptions.retryOptions

userAgent

追加到传递给事件中心服务的内置用户代理字符串的值。

userAgent?: string

属性值

string

继承自EventHubClientOptions.userAgent

webSocketOptions

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

webSocketOptions?: WebSocketOptions

属性值

WebSocketOptions

继承自EventHubClientOptions.webSocketOptions