EventHubClientOptions interface
描述可在建立 EventHubClient 時提供的選項。
-
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
}
}
屬性
| custom |
線上到事件中樞服務時要使用的自訂端點。 當您的網路不允許連線到標準 Azure 事件中樞 端點位址，但允許透過媒介進行連線時，這非常有用。 範例：“https://my.custom.endpoint:100/" |
| identifier | 用來識別用戶端的唯一名稱。 如果未提供，則會使用 GUID 作為標識符 |
| retry |
設定用戶端上所有作業重試原則的選項。
例如， |
| user |
附加至傳遞至事件中樞服務之內建使用者代理程式字串的值。 |
| web |
透過 Web 套接字設定 AMQP 連線通道的選項。 |
屬性詳細資料
customEndpointAddress
線上到事件中樞服務時要使用的自訂端點。 當您的網路不允許連線到標準 Azure 事件中樞 端點位址，但允許透過媒介進行連線時，這非常有用。
範例：“https://my.custom.endpoint:100/"
customEndpointAddress?: string屬性值
string
identifier
用來識別用戶端的唯一名稱。 如果未提供，則會使用 GUID 作為標識符
identifier?: string屬性值
string
retryOptions
設定用戶端上所有作業重試原則的選項。
例如，{ "maxRetries": 4 } 或 { "maxRetries": 4, "retryDelayInMs": 30000 }。
retryOptions?: RetryOptions屬性值
userAgent
附加至傳遞至事件中樞服務之內建使用者代理程式字串的值。
userAgent?: string屬性值
string