Partager via

ServiceBusClientOptions interface

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

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

  • 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.
    • 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 minimale : 6 0000 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 Azure Service Bus standard, 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 d’ajout de détails de l’agent utilisateur aux demandes sortantes.
webSocketOptions

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

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 Azure Service Bus standard, 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 d’ajout de détails de l’agent utilisateur aux demandes sortantes.

userAgentOptions?: UserAgentPolicyOptions

Valeur de propriété

UserAgentPolicyOptions

webSocketOptions

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

webSocketOptions?: WebSocketOptions

Valeur de propriété

WebSocketOptions