EventHubConsumerClientOptions interface

Paquet:

@azure/event-hubs

Décrit les options qui peuvent être fournies lors de la création d’EventHubConsumerClient.

• loadBalancingOptions: options permettant de régler la façon dont les partitions de revendications EventHubConsumerClient.
• userAgent : chaîne à ajouter à la chaîne d’agent utilisateur intégrée qui est passée en tant que propriété de connexion au service.
• webSocketOptions : options permettant de configurer le canal de la connexion AMQP via Web Sockets.
  • websocket : constructeur WebSocket utilisé pour créer une connexion AMQP si vous choisissez d’établir la connexion sur un WebSocket.
  • webSocketConstructorOptions : options à passer au constructeur Websocket lorsque vous choisissez d’établir la connexion sur un WebSocket.
• retryOptions : options de nouvelle tentative pour toutes les opérations sur le client/producteur/consommateur.
  • maxRetries : nombre de fois où l’opération peut être retentée en cas d’erreur retentable.
  • maxRetryDelayInMs: délai maximal entre les nouvelles tentatives. Applicable uniquement lors de l’exécution de nouvelles tentatives exponentielles.
  • mode: mode nouvelle tentative à appliquer, spécifié par l’énumération RetryMode. Les options sont Exponential et Fixed. La valeur par défaut est Fixed.
  • retryDelayInMs: durée d’attente en millisecondes avant d’effectuer la prochaine tentative. Lorsque mode est défini sur Exponential, il est utilisé pour calculer les retards croissants exponentiels entre les nouvelles tentatives. Valeur par défaut : 3 0000 millisecondes.
  • timeoutInMs: Durée en millisecondes d’attente avant que l’opération expire. Cela déclenche une nouvelle tentative s’il existe des tentatives de nouvelle tentative restantes. Valeur par défaut : 6 0000 millisecondes.

Une utilisation simple peut être { "maxRetries": 4 }.

Exemple d’utilisation :

{
    retryOptions: {
        maxRetries: 4
    }
}

Extends

EventHubClientOptions

Propriétés

loadBalancingOptions

Options permettant de régler la façon dont les partitions de revendications EventHubConsumerClient.

Propriétés héritées

customEndpointAddress	Point de terminaison personnalisé à utiliser lors de la connexion au service Event Hubs. Cela peut être utile lorsque votre réseau n’autorise pas la connexion à l’adresse de point de terminaison Azure Event Hubs standard, mais autorise la connexion via un intermédiaire. Exemple : «https://my.custom.endpoint:100/"
identifier	Nom unique utilisé pour identifier le client. S’il n’est pas fourni, un GUID sera utilisé comme identificateur
retryOptions	Options permettant de configurer la stratégie de nouvelle tentative pour toutes les opérations sur le client. Par exemple, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent	Valeur ajoutée à la chaîne d’agent utilisateur intégrée transmise au service Event Hubs.
webSocketOptions	Options de configuration du canal de la connexion AMQP via Web Sockets.

Détails de la propriété

loadBalancingOptions

Options permettant de régler la façon dont les partitions de revendications EventHubConsumerClient.

loadBalancingOptions?: LoadBalancingOptions

Valeur de propriété

LoadBalancingOptions

Détails de la propriété héritée

customEndpointAddress

Point de terminaison personnalisé à utiliser lors de la connexion au service Event Hubs. Cela peut être utile lorsque votre réseau n’autorise pas la connexion à l’adresse de point de terminaison Azure Event Hubs standard, mais autorise la connexion via un intermédiaire.

Exemple : «https://my.custom.endpoint:100/"

customEndpointAddress?: string

Valeur de propriété

string

héritée deEventHubClientOptions.customEndpointAddress

identifier

Nom unique utilisé pour identifier le client. S’il n’est pas fourni, un GUID sera utilisé comme identificateur

identifier?: string

Valeur de propriété

string

héritée deEventHubClientOptions.identifier

retryOptions

Options permettant de configurer la stratégie de nouvelle tentative pour toutes les opérations sur le client. Par exemple, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Valeur de propriété

RetryOptions

héritée deEventHubClientOptions.retryOptions

userAgent

Valeur ajoutée à la chaîne d’agent utilisateur intégrée transmise au service Event Hubs.

userAgent?: string

Valeur de propriété

string

héritée deEventHubClientOptions.userAgent

webSocketOptions

Options de configuration du canal de la connexion AMQP via Web Sockets.

webSocketOptions?: WebSocketOptions

Valeur de propriété

WebSocketOptions

héritée deEventHubClientOptions.webSocketOptions