Partager via

ServiceBusSender interface

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

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.

Propriétés

entityPath

Chemin de l’entité pour laquelle l’expéditeur a été créé.
identifier

Nom utilisé pour identifier l’expéditeur. Cela peut être utilisé pour mettre en corrélation les journaux et les exceptions. S’il n’est pas spécifié ou vide, un unique aléatoire est généré.
isClosed

Retourne true si l’expéditeur ou le client qui l’a créé a été fermé.

Méthodes

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Annule plusieurs messages qui ont été planifiés pour apparaître dans une file d’attente/un abonnement ServiceBus.
close()

Ferme le lien d’expéditeur AMQP sous-jacent. Une fois fermé, l’expéditeur ne peut pas être utilisé pour d’autres opérations. Utiliser la createSender fonction sur QueueClient ou TopicClient pour instancier un nouvel expéditeur
createMessageBatch(CreateMessageBatchOptions)

Crée une instance de à laquelle on peut ajouter des ServiceBusMessageBatch messages jusqu’à ce que la taille maximale prise en charge soit atteinte. Le lot peut être passé à la <xref:send> méthode pour envoyer les messages à Azure Service Bus.
scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Planifie l’affichage ultérieur des messages donnés dans la file d’attente/l’abonnement Service Bus.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Envoie les messages donnés après avoir créé un lien Expéditeur AMQP s’il n’existe pas déjà.

  • Pour envoyer des messages à une session file d’attente/rubrique activée et/ou partition activée, définissez les sessionId propriétés et/ou partitionKey respectivement sur les messages.
  • Tous les messages passés au même appel sendMessages() doivent avoir le même sessionId (si vous utilisez des sessions) et le même partitionKey (si vous utilisez des partitions).

Remarque :

Si vous souhaitez envoyer des messages d’une taille supérieure à 1 Mo, envoyez des messages individuels au lieu d’envoyer un message par lot ou un tableau de messages comme ci-dessous.

await sender.sendMessages(message);

Cela est dû au fait que les messages par lots ne sont pas encore capables d’envoyer les messages plus volumineux. Dans le cas contraire, vous obtiendrez l’erreur force detached . Lisez service-bus-premium-messaging#large-messages-support. Plus d’informations sur #23014.

Détails de la propriété

entityPath

Chemin de l’entité pour laquelle l’expéditeur a été créé.

entityPath: string

Valeur de propriété

string

identifier

Nom utilisé pour identifier l’expéditeur. Cela peut être utilisé pour mettre en corrélation les journaux et les exceptions. S’il n’est pas spécifié ou vide, un unique aléatoire est généré.

identifier: string

Valeur de propriété

string

isClosed

Retourne true si l’expéditeur ou le client qui l’a créé a été fermé.

isClosed: boolean

Valeur de propriété

boolean

Détails de la méthode

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Annule plusieurs messages qui ont été planifiés pour apparaître dans une file d’attente/un abonnement ServiceBus.

function cancelScheduledMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<void>

Paramètres

sequenceNumbers

Long | Long[]

Numéro de séquence ou tableau de numéros de séquence des messages à annuler.

options
OperationOptionsBase

Sac d’options pour passer un signal d’abandon ou des options de traçage.

Retours

Promise<void>

close()

Ferme le lien d’expéditeur AMQP sous-jacent. Une fois fermé, l’expéditeur ne peut pas être utilisé pour d’autres opérations. Utiliser la createSender fonction sur QueueClient ou TopicClient pour instancier un nouvel expéditeur

function close(): Promise<void>

Retours

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

Crée une instance de à laquelle on peut ajouter des ServiceBusMessageBatch messages jusqu’à ce que la taille maximale prise en charge soit atteinte. Le lot peut être passé à la <xref:send> méthode pour envoyer les messages à Azure Service Bus.

function createMessageBatch(options?: CreateMessageBatchOptions): Promise<ServiceBusMessageBatch>

Paramètres

options
CreateMessageBatchOptions

Configure le comportement du lot.

  • maxSizeInBytes: limite supérieure pour la taille du lot. La tryAdd fonction retourne false une fois cette limite atteinte.

Retours

Promise<ServiceBusMessageBatch>

scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Planifie l’affichage ultérieur des messages donnés dans la file d’attente/l’abonnement Service Bus.

function scheduleMessages(messages: ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], scheduledEnqueueTimeUtc: Date, options?: OperationOptionsBase): Promise<Long[]>

Paramètres

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Message ou tableau de messages qui doivent être planifiés.

scheduledEnqueueTimeUtc

Date

Heure UTC à laquelle les messages doivent être mis en file d’attente.

options
OperationOptionsBase

Sac d’options pour passer un signal d’abandon ou des options de traçage.

Retours

Promise<Long[]>

Numéros de séquence des messages qui ont été planifiés. Vous aurez besoin du numéro de séquence si vous envisagez d’annuler la planification des messages. Enregistrez le Long type tel qu’il est dans votre application sans effectuer de conversion en nombre. Étant donné que JavaScript prend uniquement en charge les nombres de 53 bits, la conversion du Long en nombre entraîne une perte de précision.

sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Envoie les messages donnés après avoir créé un lien Expéditeur AMQP s’il n’existe pas déjà.

  • Pour envoyer des messages à une session file d’attente/rubrique activée et/ou partition activée, définissez les sessionId propriétés et/ou partitionKey respectivement sur les messages.
  • Tous les messages passés au même appel sendMessages() doivent avoir le même sessionId (si vous utilisez des sessions) et le même partitionKey (si vous utilisez des partitions).

Remarque :

Si vous souhaitez envoyer des messages d’une taille supérieure à 1 Mo, envoyez des messages individuels au lieu d’envoyer un message par lot ou un tableau de messages comme ci-dessous.

await sender.sendMessages(message);

Cela est dû au fait que les messages par lots ne sont pas encore capables d’envoyer les messages plus volumineux. Dans le cas contraire, vous obtiendrez l’erreur force detached . Lisez service-bus-premium-messaging#large-messages-support. Plus d’informations sur #23014.

function sendMessages(messages: ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], options?: OperationOptionsBase): Promise<void>

Paramètres

messages

ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Un message unique ou un tableau de messages ou un lot de messages créés via la méthode createBatch() à envoyer.

options
OperationOptionsBase

Sac d’options pour passer un signal d’abandon ou des options de traçage.

Retours

Promise<void>