Partager via

ServiceBusClientOptions interface

  • Référence
Paquet:
@azure/service-bus

Décrit les options qui peuvent être fournies lors de la création du ServiceBusClient.

  • 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 sur 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.
    • 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 minimale : 60000 millisecondes.

Propriétés

customEndpointAddress

Point de terminaison personnalisé à utiliser lors de la connexion au service Service Bus. Cela peut être utile lorsque votre réseau n’autorise pas la connexion à l’adresse de point de terminaison standard Azure Service Bus, mais autorise la connexion via un intermédiaire. Exemple : «https://my.custom.endpoint:100/" ;
identifier

ID permettant d’identifier ce client. Cela peut être utilisé pour mettre en corrélation les journaux et les exceptions.
retryOptions

Options de stratégie de nouvelle tentative qui déterminent le mode, le nombre de nouvelles tentatives, l’intervalle de nouvelle tentative, etc.
userAgentOptions

Options permettant d’ajouter des détails de l’agent utilisateur aux requêtes sortantes.
webSocketOptions

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

Détails de la propriété

customEndpointAddress

Point de terminaison personnalisé à utiliser lors de la connexion au service Service Bus. Cela peut être utile lorsque votre réseau n’autorise pas la connexion à l’adresse de point de terminaison standard Azure Service Bus, mais autorise la connexion via un intermédiaire. Exemple : «https://my.custom.endpoint:100/" ;

customEndpointAddress?: string

Valeur de propriété

string

identifier

ID permettant d’identifier ce client. Cela peut être utilisé pour mettre en corrélation les journaux et les exceptions.

identifier?: string

Valeur de propriété

string

retryOptions

Options de stratégie de nouvelle tentative qui déterminent le mode, le nombre de nouvelles tentatives, l’intervalle de nouvelle tentative, etc.

retryOptions?: RetryOptions

Valeur de propriété

RetryOptions

userAgentOptions

Options permettant d’ajouter des détails de l’agent utilisateur aux requêtes sortantes.

userAgentOptions?: UserAgentPolicyOptions

Valeur de propriété

UserAgentPolicyOptions

webSocketOptions

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

webSocketOptions?: WebSocketOptions

Valeur de propriété

WebSocketOptions