Partager via

EventHubConsumerClientOptions interface

  • Référence
Paquet:
@azure/event-hubs

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

  • loadBalancingOptions: options permettant d’ajuster la façon dont EventHubConsumerClient revendique les partitions.
  • 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 sur des sockets web.
    • websocket : constructeur WebSocket utilisé pour créer une connexion AMQP si vous choisissez d’établir la connexion via un WebSocket.
    • webSocketConstructorOptions : options à passer au constructeur Websocket lorsque vous choisissez d’établir la connexion via 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 pouvant faire l’objet d’une nouvelle tentative.
    • maxRetryDelayInMs: délai maximal entre les nouvelles tentatives. Applicable uniquement lors de l’exécution de nouvelles tentatives exponentielles.
    • mode: mode de nouvelle tentative à appliquer, spécifié par l’énumération RetryMode . Les options sont Exponential et Fixed. La valeur par défaut est Fixed.
    • retryDelayInMs: délai 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 de façon exponentielle entre les nouvelles tentatives. Valeur par défaut : 30000 millisecondes.
    • timeoutInMs: délai d’attente en millisecondes avant l’expiration de l’opération. Cela déclenche une nouvelle tentative s’il reste des tentatives. Valeur par défaut : 60000 millisecondes.

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

Exemple d'utilisation :

{
    retryOptions: {
        maxRetries: 4
    }
}
Extends
EventHubClientOptions

Propriétés

loadBalancingOptions

Options permettant d’ajuster la façon dont EventHubConsumerClient revendique les partitions.

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 standard Azure Event Hubs, 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 est 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 qui est passée au service Event Hubs.
webSocketOptions

Options permettant de configurer le canal de la connexion AMQP sur des sockets web.

Détails de la propriété

loadBalancingOptions

Options permettant d’ajuster la façon dont EventHubConsumerClient revendique les partitions.

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 standard Azure Event Hubs, mais autorise la connexion via un intermédiaire.

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

customEndpointAddress?: string

Valeur de propriété

string

Héritéed’EventHubClientOptions.customEndpointAddress

identifier

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

identifier?: string

Valeur de propriété

string

Héritéd’EventHubClientOptions.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éd’EventHubClientOptions.retryOptions

userAgent

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

userAgent?: string

Valeur de propriété

string

Héritéed’EventHubClientOptions.userAgent

webSocketOptions

Options permettant de configurer le canal de la connexion AMQP sur des sockets web.

webSocketOptions?: WebSocketOptions

Valeur de propriété

WebSocketOptions

Héritéd’EventHubClientOptions.webSocketOptions