Delen via

ServiceBusSender interface

  • Referentie
Pakket:
@azure/service-bus

Een afzender kan worden gebruikt om berichten te verzenden, berichten op een later tijdstip te plannen en dergelijke geplande berichten te annuleren. Gebruik de functie createSender op de ServiceBusClient om een afzender te instantiëren. De klasse Afzender is een abstractie via de onderliggende AMQP-afzenderkoppeling.

Eigenschappen

entityPath

Pad van de entiteit waarvoor de afzender is gemaakt.
identifier

Een naam die wordt gebruikt om de afzender te identificeren. Dit kan worden gebruikt om logboeken en uitzonderingen te correleren. Als dit niet is opgegeven of leeg is, wordt er een willekeurige unieke gegenereerd.
isClosed

Retourneert true als de afzender of de client die deze heeft gemaakt, is gesloten.

Methoden

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Annuleert meerdere berichten die zijn gepland om te worden weergegeven in een ServiceBus-wachtrij/-abonnement.
close()

Hiermee sluit u de onderliggende AMQP-afzenderkoppeling. Zodra de afzender is gesloten, kan deze niet meer worden gebruikt voor verdere bewerkingen. Gebruik de functie createSender in queueClient of TopicClient om een nieuwe afzender te instantiëren
createMessageBatch(CreateMessageBatchOptions)

Hiermee maakt u een exemplaar van ServiceBusMessageBatch waaraan u berichten kunt toevoegen totdat de maximale ondersteunde grootte is bereikt. De batch kan worden doorgegeven aan de <xref:send> methode om de berichten naar Azure Service Bus te verzenden.
scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Hiermee wordt gepland dat bepaalde berichten op een later tijdstip worden weergegeven in de Service Bus-wachtrij/-abonnement.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Hiermee worden de opgegeven berichten verzonden nadat u een AMQP-afzenderkoppeling hebt gemaakt als deze nog niet bestaat.

  • Als u berichten wilt verzenden naar een session en/of partition ingeschakelde wachtrij/onderwerp, stelt u respectievelijk de eigenschappen sessionId en/of partitionKey op de berichten in.
  • Alle berichten die zijn doorgegeven aan dezelfde sendMessages()-aanroep, moeten dezelfde sessionId hebben (als er sessies worden gebruikt) en dezelfde partitionKey (als u partities gebruikt).

Opmerking:

Als u berichten van meer dan 1 MB wilt verzenden, kunt u afzonderlijke berichten verzenden in plaats van een batchbericht of een matrix met berichten zoals hieronder.

await sender.sendMessages(message);

Dit komt doordat de batchberichten nog niet in staat zijn om de grotere berichten te verzenden. In dit geval wordt de fout force detached weergegeven. Lees service-bus-premium-messaging#large-messages-support. Meer informatie op #23014.

Eigenschapdetails

entityPath

Pad van de entiteit waarvoor de afzender is gemaakt.

entityPath: string

Waarde van eigenschap

string

identifier

Een naam die wordt gebruikt om de afzender te identificeren. Dit kan worden gebruikt om logboeken en uitzonderingen te correleren. Als dit niet is opgegeven of leeg is, wordt er een willekeurige unieke gegenereerd.

identifier: string

Waarde van eigenschap

string

isClosed

Retourneert true als de afzender of de client die deze heeft gemaakt, is gesloten.

isClosed: boolean

Waarde van eigenschap

boolean

Methodedetails

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Annuleert meerdere berichten die zijn gepland om te worden weergegeven in een ServiceBus-wachtrij/-abonnement.

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

Parameters

sequenceNumbers

Long | Long[]

Volgnummer of een matrix van reeksnummers van de berichten die moeten worden geannuleerd.

options
OperationOptionsBase

Optiestas om een afgebroken signaal of traceringsopties door te geven.

Retouren

Promise<void>

close()

Hiermee sluit u de onderliggende AMQP-afzenderkoppeling. Zodra de afzender is gesloten, kan deze niet meer worden gebruikt voor verdere bewerkingen. Gebruik de functie createSender in queueClient of TopicClient om een nieuwe afzender te instantiëren

function close(): Promise<void>

Retouren

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

Hiermee maakt u een exemplaar van ServiceBusMessageBatch waaraan u berichten kunt toevoegen totdat de maximale ondersteunde grootte is bereikt. De batch kan worden doorgegeven aan de <xref:send> methode om de berichten naar Azure Service Bus te verzenden.

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

Parameters

options
CreateMessageBatchOptions

Hiermee configureert u het gedrag van de batch.

  • maxSizeInBytes: de bovengrens voor de grootte van de batch. De functie tryAdd retourneert false nadat deze limiet is bereikt.

Retouren

Promise<ServiceBusMessageBatch>

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

Hiermee wordt gepland dat bepaalde berichten op een later tijdstip worden weergegeven in de Service Bus-wachtrij/-abonnement.

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

Parameters

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Bericht of een matrix met berichten die moeten worden gepland.

scheduledEnqueueTimeUtc

Date

Het UTC-tijdstip waarop de berichten moeten worden ge enqueueerd.

options
OperationOptionsBase

Optiestas om een afgebroken signaal of traceringsopties door te geven.

Retouren

Promise<Long[]>

De volgnummers van berichten die zijn gepland. U hebt het volgnummer nodig als u de planning van de berichten wilt annuleren. Sla het Long type as-is op in uw toepassing zonder te converteren naar getal. Omdat JavaScript alleen 53-bits getallen ondersteunt, leidt het converteren van de Long naar getal tot verlies in precisie.

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

Hiermee worden de opgegeven berichten verzonden nadat u een AMQP-afzenderkoppeling hebt gemaakt als deze nog niet bestaat.

  • Als u berichten wilt verzenden naar een session en/of partition ingeschakelde wachtrij/onderwerp, stelt u respectievelijk de eigenschappen sessionId en/of partitionKey op de berichten in.
  • Alle berichten die zijn doorgegeven aan dezelfde sendMessages()-aanroep, moeten dezelfde sessionId hebben (als er sessies worden gebruikt) en dezelfde partitionKey (als u partities gebruikt).

Opmerking:

Als u berichten van meer dan 1 MB wilt verzenden, kunt u afzonderlijke berichten verzenden in plaats van een batchbericht of een matrix met berichten zoals hieronder.

await sender.sendMessages(message);

Dit komt doordat de batchberichten nog niet in staat zijn om de grotere berichten te verzenden. In dit geval wordt de fout force detached weergegeven. Lees service-bus-premium-messaging#large-messages-support. Meer informatie op #23014.

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

Parameters

messages

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

Eén bericht of een matrix met berichten of een batch berichten die zijn gemaakt via de methode createBatch() die moet worden verzonden.

options
OperationOptionsBase

Optiestas om een afgebroken signaal of traceringsopties door te geven.

Retouren

Promise<void>