Delen via

EventHubConsumerClientOptions interface

  • Referentie
Pakket:
@azure/event-hubs

Beschrijft de opties die kunnen worden opgegeven tijdens het maken van de EventHubConsumerClient.

  • loadBalancingOptions: Opties voor het afstemmen van de partities van eventHubConsumerClient.
  • userAgent: een tekenreeks die moet worden toegevoegd aan de ingebouwde tekenreeks van de gebruikersagent die wordt doorgegeven als een verbindingseigenschap aan de service.
  • webSocketOptions: opties voor het configureren van de kanaalling van de AMQP-verbinding via Web Sockets.
    • websocket: de WebSocket-constructor die wordt gebruikt om een AMQP-verbinding te maken als u ervoor kiest om verbinding te maken via een WebSocket.
    • webSocketConstructorOptions: Opties om door te geven aan de Websocket-constructor wanneer u ervoor kiest om verbinding te maken via een WebSocket.
  • retryOptions: de opties voor opnieuw proberen voor alle bewerkingen op de client/producent/consument.
    • maxRetries: het aantal keren dat de bewerking opnieuw kan worden uitgevoerd in het geval van een fout die opnieuw kan worden geprobeerd.
    • maxRetryDelayInMs: de maximale vertraging tussen nieuwe pogingen. Alleen van toepassing wanneer exponentieel nieuwe pogingen worden uitgevoerd.
    • mode: welke modus voor opnieuw proberen moet worden toegepast, opgegeven door de RetryMode enum. Opties zijn Exponential en Fixed. Standaard ingesteld op Fixed.
    • retryDelayInMs: De hoeveelheid tijd die moet worden gewacht in milliseconden voordat u de volgende poging probeert uit te voeren. Wanneer mode is ingesteld op Exponential, wordt dit gebruikt om de exponentieel toenemende vertragingen tussen nieuwe pogingen te berekenen. Standaard: 30000 milliseconden.
    • timeoutInMs: De hoeveelheid tijd in milliseconden die moet worden gewacht voordat er een time-out optreedt voor de bewerking. Hiermee wordt een nieuwe poging geactiveerd als er nog nieuwe pogingen zijn. Standaardwaarde: 60000 milliseconden.

Een eenvoudig gebruik kan worden { "maxRetries": 4 }.

Voorbeeldgebruik:

{
    retryOptions: {
        maxRetries: 4
    }
}
Uitbreiding
EventHubClientOptions

Eigenschappen

loadBalancingOptions

Opties om af te stemmen hoe de EventHubConsumerClient-partities worden geclaimd.

Overgenomen eigenschappen

customEndpointAddress

Een aangepast eindpunt dat moet worden gebruikt bij het maken van verbinding met de Event Hubs-service. Dit kan handig zijn wanneer uw netwerk geen verbinding toestaat met het standaardadres van het Azure Event Hubs-eindpunt, maar wel verbinding via een intermediair toestaat.

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

Een unieke naam die wordt gebruikt om de client te identificeren. Indien niet opgegeven, wordt een GUID gebruikt als de id
retryOptions

Opties voor het configureren van het beleid voor opnieuw proberen voor alle bewerkingen op de client. Bijvoorbeeld { "maxRetries": 4 } of { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Waarde die wordt toegevoegd aan de ingebouwde tekenreeks van de gebruikersagent die wordt doorgegeven aan de Event Hubs-service.
webSocketOptions

Opties voor het configureren van de kanaalling van de AMQP-verbinding via Web Sockets.

Eigenschapdetails

loadBalancingOptions

Opties om af te stemmen hoe de EventHubConsumerClient-partities worden geclaimd.

loadBalancingOptions?: LoadBalancingOptions

Waarde van eigenschap

LoadBalancingOptions

Details van overgenomen eigenschap

customEndpointAddress

Een aangepast eindpunt dat moet worden gebruikt bij het maken van verbinding met de Event Hubs-service. Dit kan handig zijn wanneer uw netwerk geen verbinding toestaat met het standaardadres van het Azure Event Hubs-eindpunt, maar wel verbinding via een intermediair toestaat.

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

customEndpointAddress?: string

Waarde van eigenschap

string

overgenomen vanEventHubClientOptions.customEndpointAddress

identifier

Een unieke naam die wordt gebruikt om de client te identificeren. Indien niet opgegeven, wordt een GUID gebruikt als de id

identifier?: string

Waarde van eigenschap

string

overgenomen vanEventHubClientOptions.identifier

retryOptions

Opties voor het configureren van het beleid voor opnieuw proberen voor alle bewerkingen op de client. Bijvoorbeeld { "maxRetries": 4 } of { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Waarde van eigenschap

RetryOptions

overgenomen vanEventHubClientOptions.retryOptions-

userAgent

Waarde die wordt toegevoegd aan de ingebouwde tekenreeks van de gebruikersagent die wordt doorgegeven aan de Event Hubs-service.

userAgent?: string

Waarde van eigenschap

string

overgenomen vanEventHubClientOptions.userAgent-

webSocketOptions

Opties voor het configureren van de kanaalling van de AMQP-verbinding via Web Sockets.

webSocketOptions?: WebSocketOptions

Waarde van eigenschap

WebSocketOptions

overgenomen vanEventHubClientOptions.webSocketOptions-