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 gör anspråk på 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 som åtgärden kan försökas igen om det uppstår ett återförsöksfel.
    • maxRetryDelayInMs: Den maximala fördröjningen mellan återförsök. Gäller endast när du utför exponentiella återförsök.
    • mode: Vilket återförsöksläge som ska tillämpas, som anges av RetryMode uppräkningen. Alternativen är Exponential och Fixed. Standardvärdet är Fixed.
    • retryDelayInMs: Hur lång tid det tar att vänta i millisekunder innan du gör nästa försök. När mode är inställt på Exponentialanvänds detta för att beräkna de exponentiellt ökande fördröjningarna mellan återförsök. Standard: 3 000 millisekunder.
    • timeoutInMs: Hur lång tid i millisekunder som ska vänta innan tidsgränsen uppnås för åtgärden. Detta utlöser ett nytt försök om det finns några återförsök kvar. Standardvärde: 60 000 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 vid anslutning till Event Hubs-tjänsten. Detta kan vara användbart när nätverket inte tillåter anslutning till standardadressen Azure Event Hubs slutpunkt, 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 inget anges används ett GUID som identifierare
retryOptions

Alternativ för att konfigurera återförsöksprincipen för alla åtgärder på klienten. 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 vid anslutning till Event Hubs-tjänsten. Detta kan vara användbart när nätverket inte tillåter anslutning till standardadressen Azure Event Hubs slutpunkt, 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 inget 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. Exempel: { "maxRetries": 4 } eller { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Egenskapsvärde

RetryOptions

Ärvt 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

Ärvt frånEventHubClientOptions.webSocketOptions