EventHubClientOptions interface

Csomag:
@azure/event-hubs

Az EventHubClient létrehozása során megadható beállításokat ismerteti.

  • userAgent: A szolgáltatáshoz kapcsolati tulajdonságként átadott beépített felhasználóiügynök-sztringhez hozzáfűzni kívánt sztring.
  • 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 ügyfél/gyártó/fogyasztó összes műveletének újrapróbálkozási lehetőségei.
    • maxRetries: A művelet újrapróbálkozásának 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 esetén alkalmazható.
    • mode: Melyik újrapróbálkozási módot kell alkalmazni a RetryMode enumerálás által megadott módon. A beállítások Exponential és Fixed. Alapértelmezés szerint Fixed.
    • retryDelayInMs: A következő kísérlet végrehajtása előtt ezredmásodpercben várni kell. Ha modeExponentialértékre van á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á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 { "maxRetries": 4 }lehet.

Példahasználat:

{
    retryOptions: {
        maxRetries: 4
    }
}

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 normál 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ára szolgáló beállítások 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 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áshoz használandó egyéni végpont. Ez akkor lehet hasznos, ha a hálózat nem engedélyezi a normál 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

identifier?: string

Tulajdonság értéke

string

retryOptions

Az újrapróbálkozási szabályzat konfigurálására szolgáló beállítások 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 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