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：進行下一次嘗試之前，以毫秒為單位等候的時間量。 當 mode 設定為 Exponential時，這會用來計算重試之間的指數增加延遲。 默認值：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