مشاركة عبر

ServiceBusSender interface

الحزمة:
@azure/service-bus

يمكن استخدام المرسل لإرسال الرسائل وجدولة الرسائل لإرسالها في وقت لاحق وإلغاء هذه الرسائل المجدولة. استخدم الدالة createSender على ServiceBusClient لإنشاء مثيل لمرسل. فئة المرسل عبارة عن تجريد عبر ارتباط مرسل AMQP الأساسي.

الخصائص

entityPath

مسار الكيان الذي تم إنشاء المرسل له.
identifier

اسم يستخدم لتعريف المرسل. يمكن استخدام هذا لربط السجلات والاستثناءات. إذا لم يتم تحديده أو إفراغه، إنشاء واحد فريد عشوائي.
isClosed

إرجاع true إذا تم إغلاق المرسل أو العميل الذي أنشأه.

الأساليب

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

إلغاء رسائل متعددة تمت جدولتها لتظهر على قائمة انتظار/اشتراك ServiceBus.
close()

إغلاق ارتباط مرسل AMQP الأساسي. بمجرد إغلاقه، لا يمكن استخدام المرسل لأي عمليات أخرى. استخدم الدالة createSender على QueueClient أو TopicClient لإنشاء مثيل لمرسل جديد
createMessageBatch(CreateMessageBatchOptions)

إنشاء مثيل ServiceBusMessageBatch يمكن للمرء إضافة رسائل إليه حتى يتم الوصول إلى الحد الأقصى للحجم المدعوم. يمكن تمرير الدفعة إلى أسلوب <xref:send> لإرسال الرسائل إلى ناقل خدمة Microsoft Azure.
scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

الجداول الزمنية المحددة للرسائل لتظهر في قائمة انتظار/اشتراك ناقل خدمة Microsoft Azure في وقت لاحق.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

إرسال الرسائل المحددة بعد إنشاء ارتباط مرسل AMQP إذا لم يكن موجودا بالفعل.

  • لإرسال رسائل إلى قائمة انتظار/موضوع ممكنة session و/أو partition، قم بتعيين خصائص sessionId و/أو partitionKey على التوالي على الرسائل.
  • يجب أن يكون لكافة الرسائل التي تم تمريرها إلى نفس استدعاء sendMessages() نفس sessionId (إذا كنت تستخدم جلسات العمل) ونفس partitionKey (في حالة استخدام الأقسام).

ملاحظة :

إذا كنت تريد إرسال رسائل بحجم أكبر من 1 ميغابايت، فالرجاء إرسال رسائل فردية بدلا من إرسال رسالة مجمعة أو صفيف من الرسائل كما هو موضح أدناه.

await sender.sendMessages(message);

وذلك لأن الرسائل المجمعة غير قادرة على إرسال الرسائل الأكبر بعد. ستضرب الخطأ force detached في هذه الحالة بخلاف ذلك. اقرأ service-bus-premium-messaging#large-messages-support. مزيد من المعلومات في #23014.

تفاصيل الخاصية

entityPath

مسار الكيان الذي تم إنشاء المرسل له.

entityPath: string

قيمة الخاصية

string

identifier

اسم يستخدم لتعريف المرسل. يمكن استخدام هذا لربط السجلات والاستثناءات. إذا لم يتم تحديده أو إفراغه، إنشاء واحد فريد عشوائي.

identifier: string

قيمة الخاصية

string

isClosed

إرجاع true إذا تم إغلاق المرسل أو العميل الذي أنشأه.

isClosed: boolean

قيمة الخاصية

boolean

تفاصيل الأسلوب

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

إلغاء رسائل متعددة تمت جدولتها لتظهر على قائمة انتظار/اشتراك ServiceBus.

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

المعلمات

sequenceNumbers

Long | Long[]

رقم التسلسل أو صفيف من أرقام التسلسل للرسائل التي سيتم إلغاؤها.

options
OperationOptionsBase

حقيبة خيارات لتمرير إشارة إحباط أو خيارات التتبع.

المرتجعات

Promise<void>

close()

إغلاق ارتباط مرسل AMQP الأساسي. بمجرد إغلاقه، لا يمكن استخدام المرسل لأي عمليات أخرى. استخدم الدالة createSender على QueueClient أو TopicClient لإنشاء مثيل لمرسل جديد

function close(): Promise<void>

المرتجعات

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

إنشاء مثيل ServiceBusMessageBatch يمكن للمرء إضافة رسائل إليه حتى يتم الوصول إلى الحد الأقصى للحجم المدعوم. يمكن تمرير الدفعة إلى أسلوب <xref:send> لإرسال الرسائل إلى ناقل خدمة Microsoft Azure.

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

المعلمات

options
CreateMessageBatchOptions

تكوين سلوك الدفعة.

  • maxSizeInBytes: الحد الأعلى لحجم الدفعة. سترجع الدالة tryAddfalse بعد الوصول إلى هذا الحد.

المرتجعات

Promise<ServiceBusMessageBatch>

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

الجداول الزمنية المحددة للرسائل لتظهر في قائمة انتظار/اشتراك ناقل خدمة Microsoft Azure في وقت لاحق.

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

المعلمات

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

رسالة أو صفيف من الرسائل التي تحتاج إلى جدولة.

scheduledEnqueueTimeUtc

Date

وقت UTC الذي يجب أن يتم فيه ترتيب الرسائل في قائمة الانتظار.

options
OperationOptionsBase

حقيبة خيارات لتمرير إشارة إحباط أو خيارات التتبع.

المرتجعات

Promise<Long[]>

أرقام تسلسل الرسائل التي تمت جدولتها. ستحتاج إلى رقم التسلسل إذا كنت تنوي إلغاء جدولة الرسائل. احفظ نوع Long as-is في التطبيق الخاص بك دون التحويل إلى رقم. نظرا لأن JavaScript يدعم أرقام 53 بت فقط، فإن تحويل Long إلى رقم سيؤدي إلى فقدان الدقة.

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

إرسال الرسائل المحددة بعد إنشاء ارتباط مرسل AMQP إذا لم يكن موجودا بالفعل.

  • لإرسال رسائل إلى قائمة انتظار/موضوع ممكنة session و/أو partition، قم بتعيين خصائص sessionId و/أو partitionKey على التوالي على الرسائل.
  • يجب أن يكون لكافة الرسائل التي تم تمريرها إلى نفس استدعاء sendMessages() نفس sessionId (إذا كنت تستخدم جلسات العمل) ونفس partitionKey (في حالة استخدام الأقسام).

ملاحظة :

إذا كنت تريد إرسال رسائل بحجم أكبر من 1 ميغابايت، فالرجاء إرسال رسائل فردية بدلا من إرسال رسالة مجمعة أو صفيف من الرسائل كما هو موضح أدناه.

await sender.sendMessages(message);

وذلك لأن الرسائل المجمعة غير قادرة على إرسال الرسائل الأكبر بعد. ستضرب الخطأ force detached في هذه الحالة بخلاف ذلك. اقرأ service-bus-premium-messaging#large-messages-support. مزيد من المعلومات في #23014.

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

المعلمات

messages

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

رسالة واحدة أو صفيف من الرسائل أو دفعة من الرسائل التي تم إنشاؤها عبر أسلوب createBatch() لإرسالها.

options
OperationOptionsBase

حقيبة خيارات لتمرير إشارة إحباط أو خيارات التتبع.

المرتجعات

Promise<void>