@azure/service-bus package

Classes

MessagingError	Décrit la classe de base pour l’erreur de messagerie.
ServiceBusAdministrationClient	Toutes les opérations retournent des promesses qui se résolvent en un objet qui a la sortie appropriée. Ces objets ont également une propriété appelée _response que vous pouvez utiliser si vous souhaitez accéder à la réponse directe à partir du service.
ServiceBusClient	Un client qui peut créer des instances d’expéditeur pour envoyer des messages à des files d’attente et des rubriques, ainsi que des instances de récepteur pour recevoir des messages provenant de files d’attente et d’abonnements.
ServiceBusError	Erreurs qui se produisent dans Service Bus.

Interfaces

AuthorizationRule	Représente le type de dans les opérations de AuthorizationRule gestion basées sur ATOM.
CorrelationRuleFilter	Représente l’expression de filtre de corrélation. Un CorrelationRuleFilter contient un ensemble de conditions qui sont mises en correspondance avec les propriétés utilisateur et système des messages entrants d’un abonnement.
CreateMessageBatchOptions	Options permettant de configurer la createBatch méthode sur .Sender maxSizeInBytes: limite supérieure pour la taille du lot. Exemple d’utilisation : { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	Représente des options paramétrables dans une file d’attente
CreateSubscriptionOptions	Représente les options paramétrables sur un abonnement
CreateTopicOptions	Représente les options paramétrables d’une rubrique
DeadLetterOptions	Décrit la raison et la description de l’erreur pour la lettre morte d’un message à l’aide de la deadLetter() méthode sur le message reçu de Service Bus.
Delivery
GetMessageIteratorOptions	Options lors de l’obtention d’un itérateur itérable à partir de Service Bus.
HttpHeader	En-tête individuel dans une collection HttpHeaders.
HttpHeadersLike	Collection de paires clé/valeur d’en-tête HTTP.
HttpResponse	Propriétés d’une réponse HTTP qui seront toujours présentes.
MessageHandlers	Interface de gestionnaire de messages général (utilisée pour streamMessages).
NamespaceProperties	Représente les métadonnées liées à un espace de noms Service Bus.
OperationOptions	Type d’options de base pour toutes les opérations.
PeekMessagesOptions	Décrit les options passées à la peekMessages méthode sur un récepteur.
ProcessErrorArgs	Arguments du processError rappel.
QueueProperties	Représente l’entrée pour updateQueue.
QueueRuntimeProperties	Représente les attributs d’informations d’exécution d’une entité de file d’attente
ReceiveMessagesOptions	Options lors de la réception d’un lot de messages de Service Bus.
RetryOptions	Options de stratégie de nouvelle tentative qui déterminent le mode, le nombre de nouvelles tentatives, l’intervalle de nouvelle tentative, etc.
RuleProperties	Représente tous les attributs d’une règle.
ServiceBusAdministrationClientOptions	Représente les options clientes de .ServiceBusAdministrationClient
ServiceBusClientOptions	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 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. 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é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éclenchera une nouvelle tentative s’il reste des tentatives de nouvelle tentative. Valeur minimale : 60000 millisecondes.
ServiceBusConnectionStringProperties	Ensemble de propriétés qui composent une chaîne de connexion Service Bus.
ServiceBusMessage	Décrit le message à envoyer à Service Bus.
ServiceBusMessageBatch	Lot de messages que vous pouvez créer à l’aide de la <xref:createBatch> méthode .
ServiceBusReceivedMessage	Décrit le message reçu de Service Bus pendant les opérations d’aperçu et ne peut donc pas être réglé.
ServiceBusReceiver	Récepteur qui ne gère pas les sessions.
ServiceBusReceiverOptions	Options à utiliser lors de la création d’un récepteur.
ServiceBusRuleManager	Permet de gérer les règles d’un abonnement. Ce gestionnaire de règles nécessite uniquement les revendications Listen, tandis que ServiceBusAdministrationClient requiert gérer les revendications.
ServiceBusSender	Un expéditeur peut être utilisé pour envoyer des messages, planifier des messages à envoyer ultérieurement et annuler ces messages planifiés. Utilisez la createSender fonction sur ServiceBusClient pour instancier un expéditeur. La classe Sender est une abstraction sur le lien d’expéditeur AMQP sous-jacent.
ServiceBusSenderOptions	Options à utiliser lors de la création d’un expéditeur.
ServiceBusSessionReceiver	Récepteur qui gère les sessions, y compris le renouvellement du verrou de session.
ServiceBusSessionReceiverOptions	Décrit les options transmises aux méthodes et acceptNextSession lors de l’utilisation acceptSession d’une file d’attente/abonnement pour laquelle les sessions sont activées.
SqlRuleFilter	Représente tous les champs possibles sur SqlRuleFilter
SubscribeOptions	Options utilisées lors de l’abonnement à une file d’attente ou à un abonnement Service Bus.
SubscriptionProperties	Représente l’entrée pour updateSubscription.
SubscriptionRuntimeProperties	Représente les attributs d’informations d’exécution d’une entité d’abonnement
TokenCredential	Représente des informations d’identification capables de fournir un jeton d’authentification.
TopicProperties	Représente l’entrée pour updateTopic.
TopicRuntimeProperties	Représente les attributs d’informations d’exécution d’une entité de rubrique
TryAddOptions	Ensemble d’options permettant de propager manuellement le Span contexte pour le suivi distribué.
WebResourceLike	Description d’une requête HTTP à envoyer à un serveur distant.
WebSocketImpl	Décrit la forme requise des constructeurs WebSocket.
WebSocketOptions	Options permettant de configurer le canal de la connexion AMQP sur des sockets web.

Alias de type

EntitiesResponse	Représente le résultat de l’opération de liste sur les entités qui contient également le continuationToken pour commencer à itérer à partir de .
EntityAvailabilityStatus	Valeurs possibles pour availabilityStatus les entités de messagerie Service Bus.
EntityStatus	Valeurs possibles pour status les entités de messagerie Service Bus.
OperationOptionsBase	REMARQUE : ce type est destiné à mettre en miroir les champs et la structure appropriés à partir d’OperationOptions @azure/core-client Options de configuration du suivi et de l’objet abortSignal.
RawHttpHeaders	Collection HttpHeaders représentée sous la forme d’un objet JSON simple.
ServiceBusErrorCode	Codes d’échec Service Bus.
SqlRuleAction	Représente tous les champs possibles sur SqlRuleAction
TransferProgressEvent	Déclenché en réponse à la progression du chargement ou du téléchargement.
WithResponse	Représente la réponse retournée de l’opération avec la réponse brute.

Énumérations

RetryMode	Décrit le type de mode nouvelle tentative
TokenType	Décrit le type de jetons pris en charge.

Functions

delay<T>(number, AbortSignalLike, string, T)	Wrapper pour setTimeout qui résout une promesse après t millisecondes.
isServiceBusError(unknown)	Détermine si une erreur est de type ServiceBusError
parseServiceBusConnectionString(string)	Analyse la chaîne de connexion donnée dans les différentes propriétés applicables à Azure Service Bus. Les propriétés sont utiles pour construire ensuite un ServiceBusClient.

Informations relatives à la fonction

delay<T>(number, AbortSignalLike, string, T)

Wrapper pour setTimeout qui résout une promesse après t millisecondes.

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

Paramètres

delayInMs

number

Nombre de millisecondes à retarder.

abortSignal

AbortSignalLike

abortSignal associé à l’opération contenant.

abortErrorMsg

string

Message d’erreur d’abandon associé à l’opération contenante.

value

T

Valeur à résoudre après un délai d’attente de t millisecondes.

Retours

Promise<T | void>

• Promesse résolue

isServiceBusError(unknown)

Détermine si une erreur est de type ServiceBusError

function isServiceBusError(err: unknown): err

Paramètres

err

unknown

Erreur à vérifier pour voir s’il est de type ServiceBusError

Retours

err

parseServiceBusConnectionString(string)

Analyse la chaîne de connexion donnée dans les différentes propriétés applicables à Azure Service Bus. Les propriétés sont utiles pour construire ensuite un ServiceBusClient.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

Paramètres

connectionString

string

Chaîne de connexion associée à la stratégie d’accès partagé créée pour l’espace de noms, la file d’attente ou la rubrique Service Bus.

Retours

ServiceBusConnectionStringProperties