EventHubClientOptions interface

Balíček:

@azure/event-hubs

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

• userAgent: Řetězec, který se připojí k předdefinovanému řetězci agenta uživatele, který se předává jako vlastnost připojení ke službě.
• webSocketOptions: Možnosti konfigurace kanálu 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í konstruktoru Websocket, když se rozhodnete vytvořit připojení přes WebSocket.
• retryOptions: Možnosti opakování pro všechny operace na straně klienta, producenta nebo příjemce.
  • maxRetries: Počet opakování operace v případě chyby, která se dá opakovat.
  • 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 je mode nastavená na Exponential, slouží k výpočtu exponenciálně rostoucích zpoždění mezi opakováními. Výchozí hodnota: 30000 milisekund.
  • timeoutInMs: Doba čekání v milisekundách, než vyprší časový limit operace. Tím se aktivuje opakování, pokud zbyly nějaké pokusy o 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í adrese koncového bodu služby Azure Event Hubs, ale umožňuje připojení přes zprostředkující. Příklad: "https://my.custom.endpoint:100/"
identifier	Jedinečný název použitý 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 Například { "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 kanálu 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í adrese koncového bodu služby Azure Event Hubs, ale umožňuje připojení přes zprostředkující.

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

customEndpointAddress?: string

Hodnota vlastnosti

string

identifier

Jedinečný název použitý 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 Například { "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ý se předává službě Event Hubs.

userAgent?: string

Hodnota vlastnosti

string

webSocketOptions

Možnosti konfigurace kanálu připojení AMQP přes webové sokety

webSocketOptions?: WebSocketOptions

Hodnota vlastnosti

WebSocketOptions