Partilhar via

ServiceBusSender interface

  • Referência
Pacote:
@azure/service-bus

Um Remetente pode ser utilizado para enviar mensagens, agendar mensagens para serem enviadas mais tarde e cancelar essas mensagens agendadas. Utilize a createSender função no ServiceBusClient para instanciar um Remetente. A classe Remetente é uma abstração sobre a ligação do remetente AMQP subjacente.

Propriedades

entityPath

Caminho da entidade para a qual o remetente foi criado.
identifier

Um nome utilizado para identificar o remetente. Isto pode ser utilizado para correlacionar registos e exceções. Se não for especificado ou vazio, será gerado um exclusivo aleatório.
isClosed

Devolve true se o remetente ou o cliente que o criou tiver sido fechado.

Métodos

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Cancela várias mensagens agendadas para serem apresentadas numa Fila/Subscrição do ServiceBus.
close()

Fecha a ligação do remetente AMQP subjacente. Depois de fechado, o remetente não pode ser utilizado para mais operações. Utilizar a createSender função em QueueClient ou TopicClient para instanciar um novo Remetente
createMessageBatch(CreateMessageBatchOptions)

Cria uma instância da ServiceBusMessageBatch qual se pode adicionar mensagens até atingir o tamanho máximo suportado. O lote pode ser transmitido para o <xref:send> método para enviar as mensagens para Azure Service Bus.
scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Agenda as mensagens fornecidas para aparecerem na Fila/Subscrição do Service Bus mais tarde.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Envia as mensagens fornecidas depois de criar uma ligação do Remetente AMQP, caso ainda não exista.

  • Para enviar mensagens para uma session Fila/Tópico ativada e/ou partition ativada, defina as sessionId propriedades e/ou partitionKey respetivamente nas mensagens.
  • Todas as mensagens transmitidas para a mesma chamada sendMessages() devem ter a mesma sessionId (se utilizar sessões) e a mesma partitionKey (se utilizar partições).

Nota:

Se quiser enviar mensagens de tamanho superior a 1 MB, envie mensagens individuais em vez de enviar uma mensagem em lote ou uma matriz de mensagens, como abaixo.

await sender.sendMessages(message);

Isto deve-se ao facto de as mensagens em lote ainda não serem capazes de enviar as mensagens maiores. Caso contrário, irá ocorrer o force detached erro. Leia service-bus-premium-messaging#large-messages-support. Mais informações em #23014.

Detalhes de Propriedade

entityPath

Caminho da entidade para a qual o remetente foi criado.

entityPath: string

Valor de Propriedade

string

identifier

Um nome utilizado para identificar o remetente. Isto pode ser utilizado para correlacionar registos e exceções. Se não for especificado ou vazio, será gerado um exclusivo aleatório.

identifier: string

Valor de Propriedade

string

isClosed

Devolve true se o remetente ou o cliente que o criou tiver sido fechado.

isClosed: boolean

Valor de Propriedade

boolean

Detalhes de Método

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Cancela várias mensagens agendadas para serem apresentadas numa Fila/Subscrição do ServiceBus.

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

Parâmetros

sequenceNumbers

Long | Long[]

Número de sequência ou uma matriz de números de sequência das mensagens a cancelar.

options
OperationOptionsBase

Saco de opções para transmitir um sinal de abortar ou opções de rastreio.

Devoluções

Promise<void>

close()

Fecha a ligação do remetente AMQP subjacente. Depois de fechado, o remetente não pode ser utilizado para mais operações. Utilizar a createSender função em QueueClient ou TopicClient para instanciar um novo Remetente

function close(): Promise<void>

Devoluções

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

Cria uma instância da ServiceBusMessageBatch qual se pode adicionar mensagens até atingir o tamanho máximo suportado. O lote pode ser transmitido para o <xref:send> método para enviar as mensagens para Azure Service Bus.

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

Parâmetros

options
CreateMessageBatchOptions

Configura o comportamento do lote.

  • maxSizeInBytes: o limite superior para o tamanho do lote. A tryAdd função será devolvida false depois de este limite ser atingido.

Devoluções

Promise<ServiceBusMessageBatch>

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

Agenda as mensagens fornecidas para aparecerem na Fila/Subscrição do Service Bus mais tarde.

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

Parâmetros

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Mensagem ou uma matriz de mensagens que têm de ser agendadas.

scheduledEnqueueTimeUtc

Date

A hora UTC em que as mensagens devem ser colocadas em fila.

options
OperationOptionsBase

Saco de opções para transmitir um sinal de abortar ou opções de rastreio.

Devoluções

Promise<Long[]>

Os números de sequência de mensagens que foram agendadas. Precisará do número de sequência se pretender cancelar o agendamento das mensagens. Guarde o Long tipo tal como está na sua aplicação sem converter em número. Uma vez que o JavaScript suporta apenas números de 53 bits, converter o Long número em causará perda de precisão.

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

Envia as mensagens fornecidas depois de criar uma ligação do Remetente AMQP, caso ainda não exista.

  • Para enviar mensagens para uma session Fila/Tópico ativada e/ou partition ativada, defina as sessionId propriedades e/ou partitionKey respetivamente nas mensagens.
  • Todas as mensagens transmitidas para a mesma chamada sendMessages() devem ter a mesma sessionId (se utilizar sessões) e a mesma partitionKey (se utilizar partições).

Nota:

Se quiser enviar mensagens de tamanho superior a 1 MB, envie mensagens individuais em vez de enviar uma mensagem em lote ou uma matriz de mensagens, como abaixo.

await sender.sendMessages(message);

Isto deve-se ao facto de as mensagens em lote ainda não serem capazes de enviar as mensagens maiores. Caso contrário, irá ocorrer o force detached erro. Leia service-bus-premium-messaging#large-messages-support. Mais informações em #23014.

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

Parâmetros

messages

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

Uma única mensagem ou uma matriz de mensagens ou um lote de mensagens criadas através do método createBatch() para enviar.

options
OperationOptionsBase

Saco de opções para transmitir um sinal de abortar ou opções de rastreio.

Devoluções

Promise<void>