Sdílet prostřednictvím

EventHubClientOptions interface

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

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

  • userAgent : Řetězec, který se má připojit 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 předání do websocket konstruktoru, když se rozhodnete vytvořit připojení přes WebSocket.
  • retryOptions : Možnosti opakování pro všechny operace na klientovi, producentovi nebo příjemci.
    • maxRetries : Kolikrát je možné operaci zopakovat v případě opakovatelné chyby.
    • maxRetryDelayInMs: Maximální zpoždění mezi opakovanými pokusy. 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. Pokud zbývají nějaké pokusy o opakování, aktivuje se tím opakování. Výchozí hodnota: 60000 milisekund.

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

Příklad použití:

{
    retryOptions: {
        maxRetries: 4
    }
}

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í Azure Event Hubs adrese koncového bodu, ale umožňuje připojení přes zprostředkovatele.

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

Jedinečný název, který slouží 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 v 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ý je předán službě Event Hubs.
webSocketOptions

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

Podrobnosti 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í Azure Event Hubs adrese koncového bodu, ale umožňuje připojení přes zprostředkovatele.

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

customEndpointAddress?: string

Hodnota vlastnosti

string

identifier

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

identifier?: string

Hodnota vlastnosti

string

retryOptions

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

retryOptions?: RetryOptions

Hodnota vlastnosti

RetryOptions

userAgent

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

userAgent?: string

Hodnota vlastnosti

string

webSocketOptions

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

webSocketOptions?: WebSocketOptions

Hodnota vlastnosti

WebSocketOptions