Dela via

EventHubConsumerClientOptions interface

  • Referens
Paket:
@azure/event-hubs

Beskriver de alternativ som kan anges när du skapar EventHubConsumerClient.

  • loadBalancingOptions: Alternativ för att justera hur EventHubConsumerClient anspråk partitioner.
  • userAgent : En sträng som ska läggas till i den inbyggda användaragentsträngen som skickas som en anslutningsegenskap till tjänsten.
  • webSocketOptions : Alternativ för att konfigurera kanalisering av AMQP-anslutningen via Web Sockets.
    • websocket : WebSocket-konstruktorn som används för att skapa en AMQP-anslutning om du väljer att upprätta anslutningen via en WebSocket.
    • webSocketConstructorOptions : Alternativ för att skicka till Websocket-konstruktorn när du väljer att upprätta anslutningen via en WebSocket.
  • retryOptions : Återförsöksalternativen för alla åtgärder på klienten/producenten/konsumenten.
    • maxRetries : Antalet gånger åtgärden kan utföras igen om ett nytt försök kan göras.
    • maxRetryDelayInMs: Den maximala fördröjningen mellan återförsök. Gäller endast vid exponentiella återförsök.
    • mode: Vilket återförsöksläge som ska tillämpas, som anges av RetryMode uppräkning. Alternativen är Exponential och Fixed. Standardvärdet är Fixed.
    • retryDelayInMs: Hur lång tid det tar att vänta i millisekunder innan nästa försök görs. När mode är inställt på Exponentialanvänds detta för att beräkna exponentiellt ökande fördröjningar mellan återförsök. Standard: 30 000 millisekunder.
    • timeoutInMs: Tid i millisekunder att vänta innan åtgärden överskrider tidsgränsen. Detta utlöser ett nytt försök om det finns några återförsök kvar. Standardvärde: 6 0000 millisekunder.

En enkel användning kan vara { "maxRetries": 4 }.

Exempel på användning:

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends
EventHubClientOptions

Egenskaper

loadBalancingOptions

Alternativ för att justera hur EventHubConsumerClient gör anspråk på partitioner.

Ärvda egenskaper

customEndpointAddress

En anpassad slutpunkt som ska användas när du ansluter till Event Hubs-tjänsten. Detta kan vara användbart när nätverket inte tillåter anslutning till standardadressen för Azure Event Hubs-slutpunkten, men tillåter anslutning via en mellanhand.

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

Ett unikt namn som används för att identifiera klienten. Om det inte anges används ett GUID som identifierare
retryOptions

Alternativ för att konfigurera återförsöksprincipen för alla åtgärder på klienten. Till exempel { "maxRetries": 4 } eller { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Värde som läggs till i den inbyggda användaragentsträngen som skickas till Event Hubs-tjänsten.
webSocketOptions

Alternativ för att konfigurera kanalisering av AMQP-anslutningen via Web Sockets.

Egenskapsinformation

loadBalancingOptions

Alternativ för att justera hur EventHubConsumerClient gör anspråk på partitioner.

loadBalancingOptions?: LoadBalancingOptions

Egenskapsvärde

LoadBalancingOptions

Information om ärvda egenskaper

customEndpointAddress

En anpassad slutpunkt som ska användas när du ansluter till Event Hubs-tjänsten. Detta kan vara användbart när nätverket inte tillåter anslutning till standardadressen för Azure Event Hubs-slutpunkten, men tillåter anslutning via en mellanhand.

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

customEndpointAddress?: string

Egenskapsvärde

string

ärvd frånEventHubClientOptions.customEndpointAddress

identifier

Ett unikt namn som används för att identifiera klienten. Om det inte anges används ett GUID som identifierare

identifier?: string

Egenskapsvärde

string

ärvd frånEventHubClientOptions.identifier

retryOptions

Alternativ för att konfigurera återförsöksprincipen för alla åtgärder på klienten. Till exempel { "maxRetries": 4 } eller { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Egenskapsvärde

RetryOptions

ärvs frånEventHubClientOptions.retryOptions

userAgent

Värde som läggs till i den inbyggda användaragentsträngen som skickas till Event Hubs-tjänsten.

userAgent?: string

Egenskapsvärde

string

ärvd frånEventHubClientOptions.userAgent

webSocketOptions

Alternativ för att konfigurera kanalisering av AMQP-anslutningen via Web Sockets.

webSocketOptions?: WebSocketOptions

Egenskapsvärde

WebSocketOptions

ärvd frånEventHubClientOptions.webSocketOptions