ServiceBusSender interface

Csomag:

@azure/service-bus

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

Tulajdonságok

entityPath	Annak az entitásnak az elérési útja, amelyhez a feladó létrejött.
identifier	A feladó azonosítására használt név. Ez használható a naplók és a kivételek korrelációjának gombra. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit.
isClosed	true ad vissza, ha a feladó vagy az azt létrehozó ügyfél bezárult.

Metódusok

cancelScheduledMessages(Long | Long[], OperationOptionsBase)	Több, 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 lezárás után a feladó nem használható további műveletekhez. Új feladó példányosításához használja a QueueClient vagy a TopicClient createSender függvényét
createMessageBatch(CreateMessageBatchOptions)	Létrehoz egy ServiceBusMessageBatch-példányt, amelyhez üzeneteket adhat hozzá, amíg el nem éri a maximális támogatott méretet. A köteg továbbítható a <xref:send> metódusnak az üzenetek Azure Service Busba 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ésben.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)	Ha még nem létezik, elküldi a megadott üzeneteket egy AMQP-feladó hivatkozás létrehozása után. Ha üzeneteket szeretne küldeni egy session és/vagy partition engedélyezett üzenetsorba/témakörbe, állítsa be az üzenetek sessionId és/vagy partitionKey tulajdonságait. Az ugyanarra a sendMessages() hívásra küldött összes üzenetnek ugyanazzal a sessionId kell rendelkeznie (munkamenetek használata esetén) és ugyanazzal a partitionKey (partíciók használata esetén). megjegyzés: Ha 1 MB-nál nagyobb méretű üzeneteket szeretne küldeni, küldjön egyéni üzeneteket ahelyett, hogy kötegelt üzenetet vagy üzenettömböt küldene, mint az alábbiakban. 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 esetben a force detached hibaüzenet jelenik meg. Olvassa el service-bus-premium-messaging#large-messages-support. További információ: #23014.

Tulajdonság adatai

entityPath

Annak az entitásnak az elérési útja, amelyhez a feladó létrejött.

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ációjának gombra. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit.

identifier: string

Tulajdonság értéke

string

isClosed

true ad vissza, ha a feladó vagy az azt létrehozó ügyfél bezárult.

isClosed: boolean

Tulajdonság értéke

boolean

Metódus adatai

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Több, 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áma vagy sorszámtömbje.

options

OperationOptionsBase

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

Válaszok

Promise<void>

close()

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

function close(): Promise<void>

Válaszok

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

Létrehoz egy ServiceBusMessageBatch-példányt, amelyhez üzeneteket adhat hozzá, amíg el nem éri a maximális támogatott méretet. A köteg továbbítható a <xref:send> metódusnak az üzenetek Azure Service Busba 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 false ad vissza.

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ésben.

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

Paraméterek

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Üzenet vagy üzenettömb, amelyet ütemezni kell.

scheduledEnqueueTimeUtc

Date

Az a UTC időpont, amikor az üzeneteket be kell küldeni.

options

OperationOptionsBase

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

Válaszok

Promise<Long[]>

Az ütemezett üzenetek sorszáma. Az üzenetek ütemezésének megszakításához szüksége lesz a sorszámra. Mentse a Long típust as-is az alkalmazásban számmá alakítás nélkül. Mivel a JavaScript csak 53 bites számokat támogat, a Long számmá alakítása pontosságvesztést okoz.

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

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

• Ha üzeneteket szeretne küldeni egy session és/vagy partition engedélyezett üzenetsorba/témakörbe, állítsa be az üzenetek sessionId és/vagy partitionKey tulajdonságait.
• Az ugyanarra a sendMessages() hívásra küldött összes üzenetnek ugyanazzal a sessionId kell rendelkeznie (munkamenetek használata esetén) és ugyanazzal a partitionKey (partíciók használata esetén).

megjegyzés:

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

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 esetben a force detached hibaüzenet jelenik meg. Olvassa el service-bus-premium-messaging#large-messages-support. 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 vagy üzenetköteg, amelyet a createBatch() metódussal kell elküldeni.

options

OperationOptionsBase

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

Válaszok

Promise<void>