Condividi tramite

EventHubConsumerClientOptions interface

  • Riferimento
Pacchetto:
@azure/event-hubs

Descrive le opzioni che possono essere fornite durante la creazione di EventHubConsumerClient.

  • loadBalancingOptions: opzioni per ottimizzare la modalità di partizione delle attestazioni EventHubConsumerClient.
  • userAgent : stringa da aggiungere alla stringa predefinita dell'agente utente passata come proprietà di connessione al servizio.
  • webSocketOptions : opzioni per configurare il canale della connessione AMQP tramite Web Socket.
    • websocket : il costruttore WebSocket usato per creare una connessione AMQP se si sceglie di effettuare la connessione su un WebSocket.
    • webSocketConstructorOptions : opzioni da passare al costruttore Websocket quando si sceglie di effettuare la connessione su un WebSocket.
  • retryOptions : opzioni di ripetizione dei tentativi per tutte le operazioni sul client/producer/consumer.
    • maxRetries : numero di tentativi di ripetizione dell'operazione in caso di errore riprovabile.
    • maxRetryDelayInMs: ritardo massimo tra tentativi. Applicabile solo quando si eseguono tentativi esponenziali.
    • mode: modalità di ripetizione dei tentativi da applicare, specificata dall'enumerazione RetryMode . Le opzioni sono Exponential e Fixed. Il valore predefinito è Fixed.
    • retryDelayInMs: tempo di attesa in millisecondi prima di eseguire il tentativo successivo. Quando mode è impostato su Exponential, viene usato per calcolare i ritardi in aumento esponenziale tra i tentativi. Impostazione predefinita: 30000 millisecondi.
    • timeoutInMs: quantità di tempo in millisecondi da attendere prima del timeout dell'operazione. In questo modo verrà attivato un nuovo tentativo se sono presenti tentativi rimanenti. Valore predefinito: 60000 millisecondi.

Un utilizzo semplice può essere { "maxRetries": 4 }.

Esempio di utilizzo:

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends
EventHubClientOptions

Proprietà

loadBalancingOptions

Opzioni per ottimizzare la modalità di partizione delle attestazioni EventHubConsumerClient.

Proprietà ereditate

customEndpointAddress

Endpoint personalizzato da usare per la connessione al servizio Hub eventi. Ciò può essere utile quando la rete non consente la connessione all'indirizzo dell'endpoint di Hub eventi di Azure standard, ma consente la connessione tramite un intermediario.

Esempio: "https://my.custom.endpoint:100/"
identifier

Nome univoco usato per identificare il client. Se non specificato, verrà usato un GUID come identificatore
retryOptions

Opzioni per configurare i criteri di ripetizione dei tentativi per tutte le operazioni nel client. Ad esempio, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Valore aggiunto alla stringa dell'agente utente incorporata passata al servizio Hub eventi.
webSocketOptions

Opzioni per configurare il canale della connessione AMQP su Web Sockets.

Dettagli proprietà

loadBalancingOptions

Opzioni per ottimizzare la modalità di partizione delle attestazioni EventHubConsumerClient.

loadBalancingOptions?: LoadBalancingOptions

Valore della proprietà

LoadBalancingOptions

Dettagli proprietà ereditate

customEndpointAddress

Endpoint personalizzato da usare per la connessione al servizio Hub eventi. Ciò può essere utile quando la rete non consente la connessione all'indirizzo dell'endpoint di Hub eventi di Azure standard, ma consente la connessione tramite un intermediario.

Esempio: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

Valore della proprietà

string

Ereditato daEventHubClientOptions.customEndpointAddress

identifier

Nome univoco usato per identificare il client. Se non specificato, verrà usato un GUID come identificatore

identifier?: string

Valore della proprietà

string

Ereditato daEventHubClientOptions.identifier

retryOptions

Opzioni per configurare i criteri di ripetizione dei tentativi per tutte le operazioni nel client. Ad esempio, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Valore della proprietà

RetryOptions

Ereditato daEventHubClientOptions.retryOptions

userAgent

Valore aggiunto alla stringa dell'agente utente incorporata passata al servizio Hub eventi.

userAgent?: string

Valore della proprietà

string

Ereditato daEventHubClientOptions.userAgent

webSocketOptions

Opzioni per configurare il canale della connessione AMQP su Web Sockets.

webSocketOptions?: WebSocketOptions

Valore della proprietà

WebSocketOptions

Ereditato daEventHubClientOptions.webSocketOptions