EventHubConsumerClientOptions interface

  • Referencia
Csomag:
@azure/event-hubs

Az EventHubConsumerClient létrehozásakor megadható beállítások ismertetése.

  • loadBalancingOptions: Az EventHubConsumerClient jogcímpartíciók hangolásának beállításai.
  • userAgent : A szolgáltatáshoz kapcsolati tulajdonságként átadott beépített felhasználóiügynök-sztringhez hozzáfűzendő karakterlánc.
  • webSocketOptions : Az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázásának konfigurálásának beállításai.
    • websocket : Az AMQP-kapcsolat létrehozásához használt WebSocket-konstruktor, ha a kapcsolatot WebSocketen keresztül szeretné létrehozni.
    • webSocketConstructorOptions : A Websocket-konstruktornak átadandó beállítások, ha a kapcsolatot WebSocketen keresztül szeretné létrehozni.
  • retryOptions : Az újrapróbálkozási lehetőségek az ügyfél/gyártó/fogyasztó összes műveletéhez.
    • maxRetries : Újrapróbálkozási hiba esetén a művelet újrapróbálkozásának száma.
    • maxRetryDelayInMs: Az újrapróbálkozások közötti maximális késleltetés. Csak exponenciális újrapróbálkozások végrehajtásakor alkalmazható.
    • mode: Melyik újrapróbálkozási módot kell alkalmazni az RetryMode enumerálás által megadott módon. A beállítások a és Fixeda.Exponential Alapértelmezés szerint a értékre van kapcsolva Fixed.
    • retryDelayInMs: Ennyi időt kell várni ezredmásodpercben a következő kísérlet végrehajtása előtt. Ha mode a értékre Exponentialvan állítva, ez az újrapróbálkozások közötti exponenciálisan növekvő késleltetés kiszámítására szolgál. Alapértelmezett: 30000 ezredmásodperc.
    • timeoutInMs: Ennyi idő ezredmásodpercben, amíg a művelet túllépi az időkorlátot. Ez újrapróbálkozási műveletet indít el, ha még vannak újrapróbálkozási kísérletek. Alapértelmezett érték: 60000 ezredmásodperc.

Az egyszerű használat lehet { "maxRetries": 4 }.

Példahasználat:

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends
EventHubClientOptions

Tulajdonságok

loadBalancingOptions

Az EventHubConsumerClient jogcímpartíciók hangolásának beállításai.

Örökölt tulajdonságok

customEndpointAddress

Az Event Hubs szolgáltatáshoz való csatlakozáshoz használandó egyéni végpont. Ez akkor lehet hasznos, ha a hálózat nem engedélyezi a szabványos Azure Event Hubs végpontcímhez való csatlakozást, de lehetővé teszi a közvetítőn keresztüli csatlakozást.

Példa: "https://my.custom.endpoint:100/"
identifier

Az ügyfél azonosítására használt egyedi név. Ha nincs megadva, a rendszer egy GUID azonosítót használ
retryOptions

Az újrapróbálkozási szabályzat konfigurálásának beállításai az ügyfél összes műveletéhez. Például { "maxRetries": 4 } vagy { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Az Event Hubs szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzött érték.
webSocketOptions

Az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázásának konfigurálásának beállításai.

Tulajdonság adatai

loadBalancingOptions

Az EventHubConsumerClient jogcímpartíciók hangolásának beállításai.

loadBalancingOptions?: LoadBalancingOptions

Tulajdonság értéke

LoadBalancingOptions

Örökölt tulajdonság részletei

customEndpointAddress

Az Event Hubs szolgáltatáshoz való csatlakozáshoz használandó egyéni végpont. Ez akkor lehet hasznos, ha a hálózat nem engedélyezi a szabványos Azure Event Hubs végpontcímhez való csatlakozást, de lehetővé teszi a közvetítőn keresztüli csatlakozást.

Példa: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

Tulajdonság értéke

string

Örökölt: EventHubClientOptions.customEndpointAddress

identifier

Az ügyfél azonosítására használt egyedi név. Ha nincs megadva, a rendszer egy GUID azonosítót használ

identifier?: string

Tulajdonság értéke

string

Örökölt: EventHubClientOptions.identifier

retryOptions

Az újrapróbálkozási szabályzat konfigurálásának beállításai az ügyfél összes műveletéhez. Például { "maxRetries": 4 } vagy { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Tulajdonság értéke

RetryOptions

Örökölt: EventHubClientOptions.retryOptions

userAgent

Az Event Hubs szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzött érték.

userAgent?: string

Tulajdonság értéke

string

Örökölt: EventHubClientOptions.userAgent

webSocketOptions

Az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázásának konfigurálásának beállításai.

webSocketOptions?: WebSocketOptions

Tulajdonság értéke

WebSocketOptions

Örökölt: EventHubClientOptions.webSocketOptions