Share via

EventHubClientOptions interface

  • Başvuru
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 : Bağlantıyı bir WebSocket üzerinden yapmayı seçerseniz AMQP bağlantısı oluşturmak için kullanılan WebSocket oluşturucu.
    • webSocketConstructorOptions : WebSocket üzerinden bağlantı oluşturmayı seçtiğinizde Websocket oluşturucusunun geçmesine yönelik seçenekler.
  • 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 denenebileceği süre.
    • maxRetryDelayInMs: Yeniden denemeler arasındaki maksimum gecikme. Yalnızca üstel yeniden denemeler gerçekleştirilirken geçerlidir.
    • mode: Uygulanacak yeniden deneme modu, sabit listesi tarafından RetryMode belirtilir. Seçenekler ve FixedşeklindedirExponential. Varsayılan olarak olarak Fixedgösterilir.
    • retryDelayInMs: Bir sonraki denemeyi yapmadan önce milisaniye cinsinden beklenen süre. mode olarak ayarlandığındaExponential, bu, yeniden denemeler arasındaki katlanarak artan gecikmeleri hesaplamak için kullanılır. Varsayılan: 30000 milisaniye.
    • timeoutInMs: İşlem zaman aşımına uğramadan önce 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 olabilir { "maxRetries": 4 }.

Örnek kullanım: 

{
    retryOptions: {
        maxRetries: 4
    }
}

Özellikler

customEndpointAddress

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

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

İstemciyi tanımlamak için kullanılan benzersiz ad. Sağlanmazsa, 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 } olabilir.
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. Ağınız standart Azure Event Hubs uç nokta adresine bağlanmaya izin vermiyorsa ancak bir aracı aracılığıyla bağlanmaya izin vermiyorsa bu 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ğlanmazsa, 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 } olabilir.

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