Megosztás a következőn keresztül:

ServiceBusSender interface

  • Referencia
Csomag:
@azure/service-bus

A küldővel üzeneteket küldhet, későbbre ütemezheti az üzeneteket, és megszakíthatja az ilyen ütemezett üzeneteket. createSender A ServiceBusClient függvényével példányosíthat egy feladót. A Sender osztály egy absztrakció a mögöttes AMQP-feladó hivatkozása felett.

Tulajdonságok

entityPath

Annak az entitásnak az elérési útja, amelyhez a feladót létrehozták.
identifier

A feladó azonosítására használt név. Ez használható a naplók és a kivételek korrelálásához. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit.
isClosed

Visszaadja true , ha a feladó vagy az azt létrehozó ügyfél be van zárva.

Metódusok

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Több, a ServiceBus-üzenetsoron/előfizetésben való megjelenésre ütemezett üzenet megszakítása.
close()

Bezárja a mögöttes AMQP-feladó hivatkozását. A bezárás után a feladó nem használható további műveletekhez. Új feladó példányosításához használja a createSender QueueClient vagy a TopicClient függvényt
createMessageBatch(CreateMessageBatchOptions)

Létrehoz egy példányt ServiceBusMessageBatch , amelyhez üzeneteket adhat hozzá, amíg el nem éri a maximális támogatott méretet. A köteg átadható a <xref:send> metódusnak az üzenetek Azure Service Bus való elküldéséhez.
scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Ütemezi, hogy a megadott üzenetek később jelenjenek meg a Service Bus-üzenetsoron/előfizetésen.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Elküldi a megadott üzeneteket egy AMQP-feladó hivatkozás létrehozása után, ha még nem létezik.

  • Ha egy és/vagy engedélyezett üzenetsorbasession/témakörbe szeretne üzeneteket küldeni, állítsa be az sessionId és/vagy partitionKey a tulajdonságokat az üzeneteken.partition
  • Az ugyanahhoz a sendMessages() híváshoz továbbított összes üzenetnek ugyanazzal sessionId (munkamenetek használata esetén) és ugyanazzal partitionKey (partíciók használata esetén) kell rendelkeznie.

Megjegyzés:

Ha 1 MB-nál nagyobb méretű üzeneteket szeretne küldeni, küldjön különálló üzeneteket ahelyett, hogy kötegelt üzenetet vagy az alábbihoz hasonló üzenettömböt küldene.

await sender.sendMessages(message);

Ennek az az oka, hogy a kötegelt üzenetek még nem képesek a nagyobb üzenetek küldésére. Ebben az force detached esetben máskülönben a hibát fogja tapasztalni. Olvassa el a service-bus-premium-messaging#large-messages-support című cikket. További információ: #23014.

Tulajdonság adatai

entityPath

Annak az entitásnak az elérési útja, amelyhez a feladót létrehozták.

entityPath: string

Tulajdonság értéke

string

identifier

A feladó azonosítására használt név. Ez használható a naplók és a kivételek korrelálásához. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit.

identifier: string

Tulajdonság értéke

string

isClosed

Visszaadja true , ha a feladó vagy az azt létrehozó ügyfél be van zárva.

isClosed: boolean

Tulajdonság értéke

boolean

Metódus adatai

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Több, a ServiceBus-üzenetsoron/előfizetésben való megjelenésre ütemezett üzenet megszakítása.

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

Paraméterek

sequenceNumbers

Long | Long[]

A megszakítandó üzenetek sorszámának vagy sorszámainak tömbje.

options
OperationOptionsBase

A megszakított jel vagy nyomkövetési beállítások átadására szolgáló beállításcsomag.

Válaszok

Promise<void>

close()

Bezárja a mögöttes AMQP-feladó hivatkozását. A bezárás után a feladó nem használható további műveletekhez. Új feladó példányosításához használja a createSender QueueClient vagy a TopicClient függvényt

function close(): Promise<void>

Válaszok

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

Létrehoz egy példányt ServiceBusMessageBatch , amelyhez üzeneteket adhat hozzá, amíg el nem éri a maximális támogatott méretet. A köteg átadható a <xref:send> metódusnak az üzenetek Azure Service Bus való elküldéséhez.

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

Paraméterek

options
CreateMessageBatchOptions

Konfigurálja a köteg viselkedését.

  • maxSizeInBytes: A köteg méretének felső korlátja. A tryAdd függvény a korlát elérése után fog visszatérni false .

Válaszok

Promise<ServiceBusMessageBatch>

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

Ütemezi, hogy a megadott üzenetek később jelenjenek meg a Service Bus-üzenetsoron/előfizetésen.

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

Paraméterek

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Üzenet vagy ütemezésre szoruló üzenetek tömbje.

scheduledEnqueueTimeUtc

Date

Az az IDŐPONT, amikor az üzeneteket be kell küldeni.

options
OperationOptionsBase

A megszakított jel vagy nyomkövetési beállítások átadására szolgáló beállításcsomag.

Válaszok

Promise<Long[]>

Az ütemezett üzenetek sorszáma. Ha meg szeretné szakítani az üzenetek ütemezését, szüksége lesz a sorszámra. Mentse a Long típust az alkalmazásban a számmá alakítás nélkül. Mivel a JavaScript csak az 53 bites számokat támogatja, a Long számmá konvertálása a pontosság elvesztéséhez vezet.

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

Elküldi a megadott üzeneteket egy AMQP-feladó hivatkozás létrehozása után, ha még nem létezik.

  • Ha egy és/vagy engedélyezett üzenetsorbasession/témakörbe szeretne üzeneteket küldeni, állítsa be az sessionId és/vagy partitionKey a tulajdonságokat az üzeneteken.partition
  • Az ugyanahhoz a sendMessages() híváshoz továbbított összes üzenetnek ugyanazzal sessionId (munkamenetek használata esetén) és ugyanazzal partitionKey (partíciók használata esetén) kell rendelkeznie.

Megjegyzés:

Ha 1 MB-nál nagyobb méretű üzeneteket szeretne küldeni, küldjön különálló üzeneteket ahelyett, hogy kötegelt üzenetet vagy az alábbihoz hasonló üzenettömböt küldene.

await sender.sendMessages(message);

Ennek az az oka, hogy a kötegelt üzenetek még nem képesek a nagyobb üzenetek küldésére. Ebben az force detached esetben máskülönben a hibát fogja tapasztalni. Olvassa el a service-bus-premium-messaging#large-messages-support című cikket. További információ: #23014.

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

Paraméterek

messages

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

Egyetlen üzenet vagy üzenettömb, illetve a küldendő createBatch() metódussal létrehozott üzenetköteg.

options
OperationOptionsBase

A megszakított jel vagy nyomkövetési beállítások átadására szolgáló beállításcsomag.

Válaszok

Promise<void>