EventHubClientOptions interface

Paket:

@azure/event-hubs

EventHubClient oluşturulurken sağlanacak seçenekleri açıklar.

• userAgent: Hizmete bağlantı özelliği olarak geçirilen yerleşik kullanıcı aracısı dizesine eklenecek dize.
• webSocketOptions: AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırma seçenekleri.
  • websocket: WebSocket üzerinden bağlantı oluşturmayı seçerseniz AMQP bağlantısı oluşturmak için kullanılan WebSocket oluşturucu.
  • webSocketConstructorOptions: Bağlantıyı bir WebSocket üzerinden yapmayı seçtiğinizde Websocket oluşturucusna geçirme seçenekleri.
• retryOptions: İstemci/üretici/tüketici üzerindeki tüm işlemler için yeniden deneme seçenekleri.
  • maxRetries: Yeniden denenebilir bir hata durumunda işlemin yeniden denenme sayısı.
  • maxRetryDelayInMs: Yeniden denemeler arasındaki en uzun gecikme. Yalnızca üstel yeniden denemeler gerçekleştirilirken geçerlidir.
  • mode: Uygulanacak yeniden deneme modu, RetryMode sabit listesi tarafından belirtilir. Seçenekler Exponential ve Fixed. varsayılan olarak Fixed.
  • retryDelayInMs: Bir sonraki denemeyi yapmadan önce milisaniye cinsinden beklenen süre. mode Exponentialolarak ayarlandığında, bu, yeniden denemeler arasındaki üstel olarak artan gecikmeleri hesaplamak için kullanılır. Varsayılan: 30000 milisaniye.
  • timeoutInMs: İşlemin zaman aşımına uğraması için milisaniye cinsinden beklenme süresi. Bu, kalan yeniden deneme girişimleri varsa yeniden denemeyi tetikler. Varsayılan değer: 60000 milisaniye.

Basit bir kullanım { "maxRetries": 4 }olabilir.

Örnek kullanım:

{
    retryOptions: {
        maxRetries: 4
    }
}

Özellikler

customEndpointAddress	Event Hubs hizmetine bağlanırken kullanılacak özel uç nokta. Bu, ağınız standart Azure Event Hubs uç noktası adresine bağlanmaya izin vermiyorsa ancak bir aracı aracılığıyla bağlanmaya izin vermiyorsa yararlı olabilir. Örnek: "https://my.custom.endpoint:100/"
identifier	İstemciyi tanımlamak için kullanılan benzersiz ad. Sağlanmadıysa, tanımlayıcı olarak bir GUID kullanılır
retryOptions	İstemcideki tüm işlemler için yeniden deneme ilkesini yapılandırma seçenekleri. Örneğin, { "maxRetries": 4 } veya { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent	Event Hubs hizmetine geçirilen yerleşik kullanıcı aracısı dizesine eklenen değer.
webSocketOptions	AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırma seçenekleri.

Özellik Ayrıntıları

customEndpointAddress

Event Hubs hizmetine bağlanırken kullanılacak özel uç nokta. Bu, ağınız standart Azure Event Hubs uç noktası adresine bağlanmaya izin vermiyorsa ancak bir aracı aracılığıyla bağlanmaya izin vermiyorsa yararlı olabilir.

Örnek: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

Özellik Değeri

string

identifier

İstemciyi tanımlamak için kullanılan benzersiz ad. Sağlanmadıysa, tanımlayıcı olarak bir GUID kullanılır

identifier?: string

Özellik Değeri

string

retryOptions

İstemcideki tüm işlemler için yeniden deneme ilkesini yapılandırma seçenekleri. Örneğin, { "maxRetries": 4 } veya { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Özellik Değeri

RetryOptions

userAgent

Event Hubs hizmetine geçirilen yerleşik kullanıcı aracısı dizesine eklenen değer.

userAgent?: string

Özellik Değeri

string

webSocketOptions

AMQP bağlantısının Web Yuvaları üzerinden kanalını yapılandırma seçenekleri.

webSocketOptions?: WebSocketOptions

Özellik Değeri

WebSocketOptions