Sdílet prostřednictvím

ServiceBusSender interface

  • Reference
Balíček:
@azure/service-bus

Odesílatele lze použít k odesílání zpráv, plánování odesílání zpráv později a zrušení takových naplánovaných zpráv. createSender K vytvoření instance odesílatele použijte funkci ServiceBusClient. Třída Sender je abstrakcí nad podkladovým odkazem odesílatele AMQP.

Vlastnosti

entityPath

Cesta entity, pro kterou byl odesílatel vytvořen.
identifier

Jméno použité k identifikaci odesílatele. Dá se použít ke korelaci protokolů a výjimek. Pokud není zadaný nebo prázdný, vygeneruje se náhodný jedinečný.
isClosed

Vrátí hodnotu true , pokud odesílatel nebo klient, který ho vytvořil, byl uzavřen.

Metody

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Zruší více zpráv, které byly naplánovány tak, aby se zobrazovaly ve frontě nebo odběru Služby ServiceBus.
close()

Zavře základní odkaz odesílatele AMQP. Po zavření nelze odesílatele použít k žádným dalším operacím. createSender Vytvoření instance nového odesílatele pomocí funkce QueueClient nebo TopicClient
createMessageBatch(CreateMessageBatchOptions)

Vytvoří instanci ServiceBusMessageBatch , do které lze přidávat zprávy, dokud není dosaženo maximální podporované velikosti. Dávku je možné předat metodě, <xref:send> která odešle zprávy do Azure Service Bus.
scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Naplánuje zobrazení zadaných zpráv ve frontě nebo odběru služby Service Bus později.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Odešle dané zprávy po vytvoření odkazu odesílatele AMQP, pokud ještě neexistuje.

  • Pokud chcete odesílat zprávy do session povolené fronty nebo partition tématu, nastavte sessionId u zpráv vlastnosti a/nebo partitionKey v uvedeném pořadí.
  • Všechny zprávy předávané do stejného volání sendMessages() by měly mít stejné sessionId (pokud používáte relace) a stejné partitionKey (pokud používáte oddíly).

Poznámka:

Pokud chcete posílat zprávy o velikosti větší než 1 MB, místo dávkové zprávy nebo pole zpráv jako níže posílejte jednotlivé zprávy.

await sender.sendMessages(message);

Je to proto, že dávkové zprávy ještě nejsou schopné odesílat větší zprávy. Jinak dojde k force detached chybě v tomto případě. Read service-bus-premium-messaging#large-messages-support. Další informace najdete na #23014.

Podrobnosti vlastnosti

entityPath

Cesta entity, pro kterou byl odesílatel vytvořen.

entityPath: string

Hodnota vlastnosti

string

identifier

Jméno použité k identifikaci odesílatele. Dá se použít ke korelaci protokolů a výjimek. Pokud není zadaný nebo prázdný, vygeneruje se náhodný jedinečný.

identifier: string

Hodnota vlastnosti

string

isClosed

Vrátí hodnotu true , pokud odesílatel nebo klient, který ho vytvořil, byl uzavřen.

isClosed: boolean

Hodnota vlastnosti

boolean

Podrobnosti metody

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Zruší více zpráv, které byly naplánovány tak, aby se zobrazovaly ve frontě nebo odběru Služby ServiceBus.

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

Parametry

sequenceNumbers

Long | Long[]

Pořadové číslo nebo matice pořadových čísel zpráv, které mají být zrušeny.

options
OperationOptionsBase

Panel možností pro předání možností přerušení signálu nebo trasování.

Návraty

Promise<void>

close()

Zavře základní odkaz odesílatele AMQP. Po zavření nelze odesílatele použít k žádným dalším operacím. createSender Vytvoření instance nového odesílatele pomocí funkce QueueClient nebo TopicClient

function close(): Promise<void>

Návraty

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

Vytvoří instanci ServiceBusMessageBatch , do které lze přidávat zprávy, dokud není dosaženo maximální podporované velikosti. Dávku je možné předat metodě, <xref:send> která odešle zprávy do Azure Service Bus.

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

Parametry

options
CreateMessageBatchOptions

Nakonfiguruje chování dávky.

  • maxSizeInBytes: Horní limit pro velikost dávky. Funkce tryAdd se vrátí false po dosažení tohoto limitu.

Návraty

Promise<ServiceBusMessageBatch>

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

Naplánuje zobrazení zadaných zpráv ve frontě nebo odběru služby Service Bus později.

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

Parametry

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Zpráva nebo pole zpráv, které je potřeba naplánovat.

scheduledEnqueueTimeUtc

Date

Čas UTC, kdy mají být zprávy zaváděny do fronty.

options
OperationOptionsBase

Panel možností pro předání možností přerušení signálu nebo trasování.

Návraty

Promise<Long[]>

Pořadová čísla zpráv, které byly naplánovány. Pokud máte v úmyslu zrušit plánování zpráv, budete potřebovat pořadové číslo. Uložte typ tak, Long jak je v aplikaci, aniž byste ho museli převádět na číslo. Vzhledem k tomu, že JavaScript podporuje pouze 53bitová čísla, převod Long na číslo způsobí ztrátu přesnosti.

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

Odešle dané zprávy po vytvoření odkazu odesílatele AMQP, pokud ještě neexistuje.

  • Pokud chcete odesílat zprávy do session povolené fronty nebo partition tématu, nastavte sessionId u zpráv vlastnosti a/nebo partitionKey v uvedeném pořadí.
  • Všechny zprávy předávané do stejného volání sendMessages() by měly mít stejné sessionId (pokud používáte relace) a stejné partitionKey (pokud používáte oddíly).

Poznámka:

Pokud chcete posílat zprávy o velikosti větší než 1 MB, místo dávkové zprávy nebo pole zpráv jako níže posílejte jednotlivé zprávy.

await sender.sendMessages(message);

Je to proto, že dávkové zprávy ještě nejsou schopné odesílat větší zprávy. Jinak dojde k force detached chybě v tomto případě. Read service-bus-premium-messaging#large-messages-support. Další informace najdete na #23014.

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

Parametry

messages

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

Jedna zpráva nebo pole zpráv nebo dávka zpráv vytvořených metodou createBatch() k odeslání.

options
OperationOptionsBase

Panel možností pro předání možností přerušení signálu nebo trasování.

Návraty

Promise<void>