Partager via

ServiceBusClient class

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

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.

Constructeurs

ServiceBusClient(string, ServiceBusClientOptions)

Crée une instance de la classe ServiceBusClient qui peut être utilisée pour créer des expéditeurs et des récepteurs vers l’espace de noms Azure Service Bus fourni dans la chaîne de connexion. Aucune connexion n’est établie au service tant que les expéditeurs/récepteurs créés avec le client ne sont pas utilisés pour envoyer/recevoir des messages.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Crée une instance de la classe ServiceBusClient qui peut être utilisée pour créer des expéditeurs et des récepteurs vers l’espace de noms Azure Service Bus fourni. Aucune connexion n’est établie au service tant que les expéditeurs/récepteurs créés avec le client ne sont pas utilisés pour envoyer/recevoir des messages.

Propriétés

fullyQualifiedNamespace

Espace de noms complet de l’instance Service Bus pour laquelle ce client est créé. Cela est susceptible d’être similaire à .servicebus.windows.net.
identifier

Nom utilisé pour identifier ce ServiceBusClient. S’il n’est pas spécifié ou vide, un unique aléatoire est généré.

Méthodes

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Crée un récepteur pour la session disponible suivante dans une file d’attente Azure Service Bus avec session.

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Crée un récepteur pour la prochaine session disponible dans un abonnement Azure Service Bus avec session.

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)

Crée un récepteur pour une session activée Azure Service Bus file d’attente.

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Crée un récepteur pour une session activée Azure Service Bus abonnement.

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()

Ferme la connexion AMQP sous-jacente. REMARQUE : cela déconnectera également toutes les instances de récepteur ou d’expéditeur créées de cette instance.
createReceiver(string, ServiceBusReceiverOptions)

Crée un récepteur pour une file d’attente Azure Service Bus. Aucune connexion au service n’est établie tant que l’une des méthodes du récepteur n’est pas appelée.

Pour cibler les sous-files d’attente telles que la file d’attente de lettres mortes ou la file d’attente de lettres mortes de transfert, indiquez dans subQueue les options. Pour en savoir plus sur les files d’attente de lettres mortes, consultez https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Les messages qui ne sont pas réglés pendant la durée du verrouillage sont réélivés autant de fois que le nombre maximal de remises défini sur la file d’attente, après quoi ils sont envoyés à une file d’attente de lettres mortes distincte.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)

Crée un récepteur pour un abonnement Azure Service Bus. Aucune connexion au service n’est établie tant que l’une des méthodes du récepteur n’est pas appelée.

Pour cibler les sous-files d’attente telles que la file d’attente de lettres mortes ou la file d’attente de lettres mortes de transfert, indiquez dans subQueue les options. Pour en savoir plus sur les files d’attente de lettres mortes, consultez https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Les messages qui ne sont pas réglés pendant la durée du verrouillage seront réélivés autant de fois que le nombre maximal de remises défini sur l’abonnement, après quoi ils sont envoyés à une file d’attente de lettres mortes distincte.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)

Crée une instance de ServiceBusRuleManager qui est utilisée pour gérer les règles d’un abonnement.
createSender(string, ServiceBusSenderOptions)

Crée un expéditeur qui peut être utilisé pour envoyer des messages, planifier les messages à envoyer ultérieurement et annuler ces messages planifiés. Aucune connexion n’est établie au service tant que l’une des méthodes de l’expéditeur n’est pas appelée.

Détails du constructeur

ServiceBusClient(string, ServiceBusClientOptions)

Crée une instance de la classe ServiceBusClient qui peut être utilisée pour créer des expéditeurs et des récepteurs vers l’espace de noms Azure Service Bus fourni dans la chaîne de connexion. Aucune connexion n’est établie au service tant que les expéditeurs/récepteurs créés avec le client ne sont pas utilisés pour envoyer/recevoir des messages.

new ServiceBusClient(connectionString: string, options?: ServiceBusClientOptions)

Paramètres

connectionString

string

Chaîne de connexion pour Azure Service Bus espace de noms. REMARQUE : cette chaîne de connexion peut contenir un EntityPath, qui est ignoré.

options
ServiceBusClientOptions

Options pour le client Service Bus.

ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Crée une instance de la classe ServiceBusClient qui peut être utilisée pour créer des expéditeurs et des récepteurs vers l’espace de noms Azure Service Bus fourni. Aucune connexion n’est établie au service tant que les expéditeurs/récepteurs créés avec le client ne sont pas utilisés pour envoyer/recevoir des messages.

new ServiceBusClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: ServiceBusClientOptions)

Paramètres

fullyQualifiedNamespace

string

Espace de noms complet de votre instance Service Bus qui est susceptible d’être similaire à .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential | SASCredential

Objet d’informations d’identification utilisé par le client pour obtenir le jeton afin d’authentifier la connexion avec le Azure Service Bus. Consultez @azure/identité pour la création des informations d’identification. Si vous utilisez une propre implémentation de l’interface TokenCredential sur AAD, définissez les « étendues » pour service-bus afin d’obtenir ["https://servicebus.azure.net//user_impersonation"] le jeton approprié. Utilisez le AzureNamedKeyCredential de @azure/core-auth si vous souhaitez passer un et SharedAccessKey sans utiliser de SharedAccessKeyName chaîne de connexion. Ces champs sont mappés au name champ et key respectivement dans AzureNamedKeyCredential. Utilisez le AzureSASCredential de @azure/core-auth si vous souhaitez passer un sans utiliser de SharedAccessSignature chaîne de connexion. Ce champ est mappé à signature dans AzureSASCredential.

options
ServiceBusClientOptions

Ensemble d’options à appliquer lors de la configuration du client.

  • retryOptions : configure la stratégie de nouvelle tentative pour toutes les opérations sur le client. Par exemple, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: configure le canal de la connexion AMQP sur des sockets web.

Détails de la propriété

fullyQualifiedNamespace

Espace de noms complet de l’instance Service Bus pour laquelle ce client est créé. Cela est susceptible d’être similaire à .servicebus.windows.net.

fullyQualifiedNamespace: string

Valeur de propriété

string

identifier

Nom utilisé pour identifier ce ServiceBusClient. S’il n’est pas spécifié ou vide, un unique aléatoire est généré.

identifier: string

Valeur de propriété

string

Détails de la méthode

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Crée un récepteur pour la session disponible suivante dans une file d’attente Azure Service Bus avec session.

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(queueName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Paramètres

queueName

string

Nom de la file d’attente à partir de laquelle recevoir.

options
ServiceBusSessionReceiverOptions

Les options incluent receiveMode (par défaut en peekLock), les options permettant de créer un récepteur de session.

Retours

Promise<ServiceBusSessionReceiver>

Récepteur qui peut être utilisé pour recevoir, consulter et régler des messages.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Crée un récepteur pour la prochaine session disponible dans un abonnement Azure Service Bus avec session.

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(topicName: string, subscriptionName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Paramètres

topicName

string

Nom de la rubrique de l’abonnement à partir duquel nous voulons recevoir.

subscriptionName

string

Nom de l’abonnement (sous ) topicà partir duquel nous voulons recevoir.

options
ServiceBusSessionReceiverOptions

Les options incluent receiveMode (par défaut en peekLock), les options permettant de créer un récepteur de session.

Retours

Promise<ServiceBusSessionReceiver>

Récepteur qui peut être utilisé pour recevoir, consulter et régler des messages.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Crée un récepteur pour une session activée Azure Service Bus file d’attente.

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(queueName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Paramètres

queueName

string

Nom de la file d’attente à partir de laquelle recevoir.

sessionId

string

ID de la session à partir de laquelle les messages doivent être reçus

options
ServiceBusSessionReceiverOptions

Les options incluent receiveMode (par défaut en peekLock), les options permettant de créer un récepteur de session.

Retours

Promise<ServiceBusSessionReceiver>

Récepteur qui peut être utilisé pour recevoir, consulter et régler des messages.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Crée un récepteur pour une session activée Azure Service Bus abonnement.

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(topicName: string, subscriptionName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Paramètres

topicName

string

Nom de la rubrique de l’abonnement à partir duquel nous voulons recevoir.

subscriptionName

string

Nom de l’abonnement (sous ) topicà partir duquel nous voulons recevoir.

sessionId

string

ID de la session à partir de laquelle les messages doivent être reçus

options
ServiceBusSessionReceiverOptions

Les options incluent receiveMode (par défaut en peekLock), les options permettant de créer un récepteur de session.

Retours

Promise<ServiceBusSessionReceiver>

Récepteur qui peut être utilisé pour recevoir, consulter et régler des messages.

close()

Ferme la connexion AMQP sous-jacente. REMARQUE : cela déconnectera également toutes les instances de récepteur ou d’expéditeur créées de cette instance.

function close(): Promise<void>

Retours

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Crée un récepteur pour une file d’attente Azure Service Bus. Aucune connexion au service n’est établie tant que l’une des méthodes du récepteur n’est pas appelée.

Pour cibler les sous-files d’attente telles que la file d’attente de lettres mortes ou la file d’attente de lettres mortes de transfert, indiquez dans subQueue les options. Pour en savoir plus sur les files d’attente de lettres mortes, consultez https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Les messages qui ne sont pas réglés pendant la durée du verrouillage sont réélivés autant de fois que le nombre maximal de remises défini sur la file d’attente, après quoi ils sont envoyés à une file d’attente de lettres mortes distincte.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(queueName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Paramètres

queueName

string

Nom de la file d’attente à partir de laquelle recevoir.

options
ServiceBusReceiverOptions

Options permettant de passer le mode de réception, la valeur par défaut est peekLock.

Retours

ServiceBusReceiver

Récepteur qui peut être utilisé pour recevoir, consulter et régler des messages.

createReceiver(string, string, ServiceBusReceiverOptions)

Crée un récepteur pour un abonnement Azure Service Bus. Aucune connexion au service n’est établie tant que l’une des méthodes du récepteur n’est pas appelée.

Pour cibler les sous-files d’attente telles que la file d’attente de lettres mortes ou la file d’attente de lettres mortes de transfert, indiquez dans subQueue les options. Pour en savoir plus sur les files d’attente de lettres mortes, consultez https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Vous pouvez choisir entre deux modes de réception : « peekLock » (par défaut) et « receiveAndDelete ».

  • En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente.
  • En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

Les messages qui ne sont pas réglés pendant la durée du verrouillage seront réélivés autant de fois que le nombre maximal de remises défini sur l’abonnement, après quoi ils sont envoyés à une file d’attente de lettres mortes distincte.

Vous pouvez régler un message en appelant les méthodes completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() sur le récepteur.

Pour plus d’informations sur le fonctionnement de peekLock et de règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(topicName: string, subscriptionName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Paramètres

topicName

string

Nom de la rubrique de l’abonnement à partir duquel nous voulons recevoir.

subscriptionName

string

Nom de l’abonnement (sous ) topicà partir duquel nous voulons recevoir.

options
ServiceBusReceiverOptions

Options permettant de passer le mode de réception, la valeur par défaut est peekLock.

Retours

ServiceBusReceiver

Récepteur qui peut être utilisé pour recevoir, consulter et régler des messages.

createRuleManager(string, string)

Crée une instance de ServiceBusRuleManager qui est utilisée pour gérer les règles d’un abonnement.

function createRuleManager(topicName: string, subscriptionName: string): ServiceBusRuleManager

Paramètres

topicName

string

rubrique pour créer ServiceBusRuleManager

subscriptionName

string

l’abonnement spécifique à la rubrique spécifiée pour laquelle créer un ServiceBusRuleManager .

Retours

ServiceBusRuleManager

ServiceBusRuleManager limité à l’abonnement et à la rubrique spécifiés.

createSender(string, ServiceBusSenderOptions)

Crée un expéditeur qui peut être utilisé pour envoyer des messages, planifier les messages à envoyer ultérieurement et annuler ces messages planifiés. Aucune connexion n’est établie au service tant que l’une des méthodes de l’expéditeur n’est pas appelée.

function createSender(queueOrTopicName: string, options?: ServiceBusSenderOptions): ServiceBusSender

Paramètres

queueOrTopicName

string

Nom d’une file d’attente ou d’une rubrique à laquelle envoyer des messages.

options
ServiceBusSenderOptions

Retours

ServiceBusSender