Sdílet prostřednictvím

EventHubConsumerClientOptions interface

  • Reference
Balíček:
@azure/event-hubs

Popisuje možnosti, které lze poskytnout při vytváření EventHubConsumerClient.

  • loadBalancingOptions: Možnosti pro vyladění deklarací oddílů EventHubConsumerClient.
  • userAgent : Řetězec, který se připojí k integrovanému řetězci uživatelského agenta, který se předá službě jako vlastnost připojení.
  • webSocketOptions : Možnosti konfigurace channelingu připojení AMQP přes webové sokety.
    • websocket : Konstruktor WebSocket použitý k vytvoření připojení AMQP, pokud se rozhodnete vytvořit připojení přes WebSocket.
    • webSocketConstructorOptions : Možnosti, které se mají předat konstruktoru WebSocket, když se rozhodnete vytvořit připojení přes protokol WebSocket.
  • retryOptions : Možnosti opakování pro všechny operace na klientovi, producentovi nebo příjemci.
    • maxRetries : Počet pokusů o opakování operace v případě chyby, která se dá opakovat.
    • maxRetryDelayInMs: Maximální zpoždění mezi opakováními. Platí pouze při provádění exponenciálních opakování.
    • mode: Který režim opakování se má použít, určený výčtem RetryMode . Možnosti jsou Exponential a Fixed. Výchozí hodnota je Fixed.
    • retryDelayInMs: Doba čekání v milisekundách před provedením dalšího pokusu. Pokud mode je nastavená hodnota Exponential, použije se k výpočtu exponenciálně rostoucích zpoždění mezi opakovanými pokusy. Výchozí hodnota: 30000 milisekund.
    • timeoutInMs: Doba čekání v milisekundách před vypršením časového limitu operace. Tím se aktivuje opakování, pokud zbývají nějaké pokusy o opakování. Výchozí hodnota: 60 000 milisekund.

Jednoduchým použitím může být { "maxRetries": 4 }.

Příklad použití:

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends
EventHubClientOptions

Vlastnosti

loadBalancingOptions

Možnosti ladění deklarací oddílů EventHubConsumerClient

Zděděné vlastnosti

customEndpointAddress

Vlastní koncový bod, který se použije při připojování ke službě Event Hubs. To může být užitečné, když vaše síť neumožňuje připojení ke standardní adrese Azure Event Hubs koncového bodu, ale umožňuje připojení prostřednictvím zprostředkovatele.

Příklad: "https://my.custom.endpoint:100/"
identifier

Jedinečný název sloužící k identifikaci klienta. Pokud není zadaný, jako identifikátor se použije identifikátor GUID.
retryOptions

Možnosti konfigurace zásad opakování pro všechny operace na klientovi Příkladem je { "maxRetries": 4 } nebo { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Hodnota, která je připojena k integrovanému řetězci uživatelského agenta, který se předává službě Event Hubs.
webSocketOptions

Možnosti konfigurace channelingu připojení AMQP přes webové sokety.

Podrobnosti vlastnosti

loadBalancingOptions

Možnosti ladění deklarací oddílů EventHubConsumerClient

loadBalancingOptions?: LoadBalancingOptions

Hodnota vlastnosti

LoadBalancingOptions

Podrobnosti zděděných vlastností

customEndpointAddress

Vlastní koncový bod, který se použije při připojování ke službě Event Hubs. To může být užitečné, když vaše síť neumožňuje připojení ke standardní adrese Azure Event Hubs koncového bodu, ale umožňuje připojení prostřednictvím zprostředkovatele.

Příklad: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

Hodnota vlastnosti

string

Zděděno zEventHubClientOptions.customEndpointAddress

identifier

Jedinečný název sloužící k identifikaci klienta. Pokud není zadaný, jako identifikátor se použije identifikátor GUID.

identifier?: string

Hodnota vlastnosti

string

Zděděno zEventHubClientOptions.identifier

retryOptions

Možnosti konfigurace zásad opakování pro všechny operace na klientovi Příkladem je { "maxRetries": 4 } nebo { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Hodnota vlastnosti

RetryOptions

Zděděno zEventHubClientOptions.retryOptions

userAgent

Hodnota, která je připojena k integrovanému řetězci uživatelského agenta, který se předává službě Event Hubs.

userAgent?: string

Hodnota vlastnosti

string

Zděděno ztřídy EventHubClientOptions.userAgent

webSocketOptions

Možnosti konfigurace channelingu připojení AMQP přes webové sokety.

webSocketOptions?: WebSocketOptions

Hodnota vlastnosti

WebSocketOptions

Zděděno zEventHubClientOptions.webSocketOptions