EventHubConsumerClientOptions interface

  • Referentie
Pakket:
@azure/event-hubs

Hierin worden de opties beschreven die kunnen worden geboden tijdens het maken van de EventHubConsumerClient.

  • loadBalancingOptions: Opties voor het afstemmen van de wijze waarop de EventHubConsumerClient-partities claimt.
  • 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 channeling 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 de verbinding via een WebSocket te maken.
    • 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 bij het uitvoeren van exponentiële nieuwe pogingen.
    • mode: welke modus voor opnieuw proberen moet worden toegepast, opgegeven door de RetryMode enum. Opties zijn Exponential en Fixed. De standaardwaarde is Fixed.
    • retryDelayInMs: de hoeveelheid tijd die moet worden gewacht in milliseconden voordat u de volgende poging uitvoert. 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 om te wachten voordat er een time-out optreedt voor de bewerking. Hierdoor wordt een nieuwe poging geactiveerd als er nog nieuwe pogingen zijn. Standaardwaarde: 60000 milliseconden.

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

Gebruiksvoorbeeld:

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends
EventHubClientOptions

Eigenschappen

loadBalancingOptions

Opties voor het afstemmen van de wijze waarop de EventHubConsumerClient-partities claimt.

Overgenomen eigenschappen

customEndpointAddress

Een aangepast eindpunt dat moet worden gebruikt om verbinding te maken met de Event Hubs-service. Dit kan handig zijn als uw netwerk geen verbinding met het standaardadres van het Azure Event Hubs-eindpunt toestaat, maar wel verbinding maakt via een tussenliggende instantie.

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

Een unieke naam die wordt gebruikt om de client te identificeren. Als deze niet wordt 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 channeling van de AMQP-verbinding via websockets.

Eigenschapdetails

loadBalancingOptions

Opties voor het afstemmen van de wijze waarop de EventHubConsumerClient-partities claimt.

loadBalancingOptions?: LoadBalancingOptions

Waarde van eigenschap

LoadBalancingOptions

Details van overgenomen eigenschap

customEndpointAddress

Een aangepast eindpunt dat moet worden gebruikt om verbinding te maken met de Event Hubs-service. Dit kan handig zijn als uw netwerk geen verbinding met het standaardadres van het Azure Event Hubs-eindpunt toestaat, maar wel verbinding maakt via een tussenliggende instantie.

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. Als deze niet wordt 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 channeling van de AMQP-verbinding via websockets.

webSocketOptions?: WebSocketOptions

Waarde van eigenschap

WebSocketOptions

Overgenomen vanEventHubClientOptions.webSocketOptions