EventHubClientOptions interface

  • Referencia
Csomag:
@azure/event-hubs

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

  • userAgent : Egy sztring, amelyet hozzá kell fűzni a beépített felhasználói ügynök sztringhez, amelyet a rendszer a szolgáltatásnak kapcsolati tulajdonságként ad át.
  • webSocketOptions : Az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázásának konfigurálására szolgáló beállítások.
    • websocket : Az AMQP-kapcsolat létrehozásához használt WebSocket-konstruktor, ha úgy dönt, hogy a kapcsolatot egy WebSocketen keresztül hozza létre.
    • webSocketConstructorOptions : A Websocket-konstruktornak átadandó beállítások, amikor a websocketen keresztüli kapcsolatot választja.
  • retryOptions : Az ügyfélen/előállítón/fogyasztón végrehajtott összes művelet újrapróbálkozási lehetőségei.
    • maxRetries : A művelet újrapróbálkozási idejének száma újrapróbálkozási hiba esetén.
    • 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 meghatározott módon. A lehetőségek a következők: Exponential és Fixed. Az alapértelmezett érték: 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ésé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ást vált ki, 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
    }
}

Tulajdonságok

customEndpointAddress

Az Event Hubs szolgáltatáshoz való csatlakozáskor használandó egyéni végpont. Ez akkor lehet hasznos, ha a hálózat nem engedélyezi a standard 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 azonosítóként
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

customEndpointAddress

Az Event Hubs szolgáltatáshoz való csatlakozáskor használandó egyéni végpont. Ez akkor lehet hasznos, ha a hálózat nem engedélyezi a standard 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

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 azonosítóként

identifier?: string

Tulajdonság értéke

string

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

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

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