EventHubClientOptions interface
Décrit les options qui peuvent être fournies lors de la création d’EventHubClient.
-
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’effectuer 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 en cas de nouvelles tentatives exponentielles. -
mode
: mode de nouvelle tentative à appliquer, spécifié par l’énumérationRetryMode
. Les options sontExponential
etFixed
. La valeur par défaut estFixed
. -
retryDelayInMs
: délai d’attente en millisecondes avant d’effectuer la prochaine tentative. Lorsquemode
est défini surExponential
, 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éclenchera une nouvelle tentative s’il reste des tentatives de nouvelle tentative. Valeur par défaut : 60000 millisecondes.
-
Une utilisation simple peut être { "maxRetries": 4 }
.
Exemple d'utilisation :
{
retryOptions: {
maxRetries: 4
}
}
Propriétés
custom |
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 sera utilisé comme identificateur |
retry |
Options permettant de configurer la stratégie de nouvelle tentative pour toutes les opérations sur le client.
Par exemple, |
user |
Valeur ajoutée à la chaîne d’agent utilisateur intégrée qui est passée au service Event Hubs. |
web |
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 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
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
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é
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
webSocketOptions
Options permettant de configurer le canal de la connexion AMQP sur des sockets web.
webSocketOptions?: WebSocketOptions