@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 sur un objet qui a la sortie appropriée.
Ces objets ont également une propriété appelée |
| ServiceBusClient |
Client qui peut créer des instances d’expéditeur pour l’envoi de messages à des files d’attente et 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 |
| 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 méthode
Exemple d’utilisation :
|
| CreateQueueOptions |
Représente les options settables d’une file d’attente |
| CreateSubscriptionOptions |
Représente les options settables sur un abonnement |
| CreateTopicOptions |
Représente les options settables d’une rubrique |
| DeadLetterOptions |
Décrit la raison et la description d’erreur pour la lettre morte d’un message à l’aide de la méthode |
| 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 sera toujours présente. |
| ListMessageSessionsOptions |
Options permettant de configurer la méthode |
| MessageHandlers |
Interface du gestionnaire de messages général (utilisée pour streamMessages). |
| NamespaceProperties |
Représente les métadonnées associées à un espace de noms Service Bus. |
| OperationOptions |
Type d’options de base pour toutes les opérations. |
| PeekMessagesOptions |
Décrit les options transmises à la méthode |
| ProcessErrorArgs |
Arguments du rappel |
| QueueProperties |
Représente l’entrée de 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 à partir 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 du |
| ServiceBusClientOptions |
Décrit les options qui peuvent être fournies lors de la création de ServiceBusClient.
|
| 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 méthode <xref:createBatch>. |
| 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 |
Autorise la gestion des règles d’un abonnement. Ce gestionnaire de règles requiert uniquement les revendications Listen, tandis que le ServiceBusAdministrationClient nécessite Gérer les revendications. |
| ServiceBusSender |
Un expéditeur peut être utilisé pour envoyer des messages, planifier les messages à envoyer ultérieurement et annuler ces messages planifiés.
Utilisez la fonction |
| 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 |
| 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 de 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 de updateTopic. |
| TopicRuntimeProperties |
Représente les attributs d’informations d’exécution d’une entité de rubrique |
| TryAddOptions |
Ensemble d’options permettant de propager manuellement |
| WebResourceLike |
Description d’une requête HTTP à effectuer sur un serveur distant. |
| WebSocketImpl |
Décrit la forme requise des constructeurs WebSocket. |
| WebSocketOptions |
Options de configuration du canal de la connexion AMQP via Web Sockets. |
Alias de type
| EntitiesResponse |
Représente le résultat de l’opération de liste sur les entités qui contient également le |
| EntityAvailabilityStatus |
Valeurs possibles pour |
| EntityStatus |
Valeurs possibles pour |
| OperationOptionsBase |
REMARQUE : Ce type est destiné à mettre en miroir les champs et la structure pertinents de Options de configuration du suivi et de l’abandonSignal. |
| RawHttpHeaders |
Collection HttpHeaders représentée en tant qu’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, ainsi que 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, Abort |
Wrapper pour setTimeout qui résout une promesse après t millisecondes. |
| is |
Typeguard pour RestError |
| is |
Détermine si une erreur est de type |
| parse |
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 ensuite construire un ServiceBusClient. |
Variables
| Rest |
Type d’erreur personnalisé pour les demandes de pipeline ayant échoué. |
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<void | T>
Paramètres
- delayInMs
-
number
Nombre de millisecondes à retarder.
- abortSignal
- AbortSignalLike
AbandonSignal associé à l’opération contenante.
- abortErrorMsg
-
string
Message d’erreur d’abandon associé à l’opération contenant.
- value
-
T
Valeur à résoudre après un délai d’expiration de t millisecondes.
Retours
Promise<void | T>
- Promesse résolue
isRestError(unknown)
Typeguard pour RestError
function isRestError(e: unknown): e is RestError
Paramètres
- e
-
unknown
Quelque chose d’intercepté par une clause catch.
Retours
e is RestError
isServiceBusError(unknown)
Détermine si une erreur est de type ServiceBusError
function isServiceBusError(err: unknown): err is ServiceBusError
Paramètres
- err
-
unknown
Erreur permettant de vérifier s’il s’agit d’un type ServiceBusError
Retours
err is 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 ensuite construire 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
Détails de variable
RestError
Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.
RestError: RestErrorConstructor