مشاركة عبر

ServiceBusMessage interface

  • ‏‏المرجع
الحزمة:
@azure/service-bus

توضح هذه المقالة الرسالة التي سيتم إرسالها إلى ناقل خدمة Microsoft Azure.

الخصائص

applicationProperties

الخصائص الخاصة بالتطبيق التي يمكن استخدامها لبيانات تعريف الرسائل المخصصة.
body

نص الرسالة الذي يجب إرساله أو تلقيه. إذا كان التطبيق الذي يتلقى الرسالة لا يستخدم SDK هذا، فحول حمولة النص الأساسي إلى صفيف بايت أو مخزن مؤقت للحصول على توافق أفضل عبر اللغات.
contentType

نوع محتوى الرسالة. يصف اختياريا حمولة الرسالة، مع واصف يتبع تنسيق RFC2045، القسم 5، على سبيل المثال "application/json".
correlationId

معرف الارتباط الذي يسمح للتطبيق بتحديد سياق للرسالة لأغراض الارتباط، على سبيل المثال يعكس MessageId لرسالة يتم الرد عليها. راجع توجيه الرسائلالارتباط.
messageId

معرف الرسالة هو قيمة معرفة من قبل التطبيق تحدد الرسالة وحمولةها بشكل فريد.

ملاحظة: الأرقام غير الصحيحة غير الصحيحة غير مسموح بها.
partitionKey

مفتاح القسم لإرسال رسالة إلى كيان مقسم. الحد الأقصى للطول هو 128 حرفا. بالنسبة الكيانات المقسمة، يتيح تعيين هذه القيمة تعيين الرسائل ذات الصلة لنفس القسم الداخلي، بحيث يتم تسجيل ترتيب تسلسل الإرسال بشكل صحيح. يتم اختيار القسم بواسطة دالة تجزئة على هذه القيمة ولا يمكن اختياره مباشرة.

  • بالنسبة للكيانات المدركة للجلسة، تتجاوز خاصية sessionId هذه القيمة.
  • بالنسبة للكيانات غير المقسمة، سيتم تجاهل مفتاح القسم
replyTo

عنوان كيان لإرسال الردود إليه. هذه القيمة الاختيارية والمعرفة بالتطبيق هي طريقة قياسية للتعبير عن مسار الرد على مستقبل الرسالة. عندما يتوقع المرسل ردا، فإنه يعين القيمة إلى المسار المطلق أو النسبي لقائمة الانتظار أو الموضوع الذي يتوقع إرسال الرد إليه. راجع توجيه الرسائلالارتباط.
replyToSessionId

معرف الجلسة الذي يزيد من عنوان replyTo. الحد الأقصى للطول هو 128 حرفا. تزيد هذه القيمة من معلومات ReplyTo وتحدد SessionId الذي يجب تعيينه للرد عند إرساله إلى كيان الرد. راجع توجيه الرسائلالارتباط.
scheduledEnqueueTimeUtc

التاريخ والوقت في التوقيت العالمي المتفق عليه الذي سيتم فيه ترتيب الرسالة في قائمة الانتظار. ترجع هذه الخاصية الوقت بالتوقيت العالمي المتفق عليه؛ عند تعيين الخاصية، يجب أن تكون قيمة DateTime المتوفرة أيضا بالتوقيت العالمي المتفق عليه. هذه القيمة مخصصة لإرسال الرسائل المتأخرة. يتم استخدامه لتأخير إرسال الرسائل إلى وقت محدد في المستقبل. لا يعني وقت ترتيب الرسائل في قائمة الانتظار أنه سيتم إرسال الرسالة في نفس الوقت. سيتم وضعها في قائمة الانتظار، ولكن وقت الإرسال الفعلي يعتمد على حمل عمل قائمة الانتظار وحالتها.
sessionId

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

التسمية الخاصة بالتطبيق. تمكن هذه الخاصية التطبيق من الإشارة إلى الغرض من الرسالة إلى المتلقي في معيار. أزياء، على غرار سطر موضوع البريد الإلكتروني. الخاصية AMQP المعينة هي "الموضوع".
timeToLive

وقت الرسالة للقيمة المباشرة. هذه القيمة هي المدة النسبية التي تنتهي بعدها صلاحية الرسالة، بدءا من لحظة قبول الرسالة وتخزينها من قبل الوسيط، كما تم التقاطها في enqueuedTimeUtc. عند عدم التعيين بشكل صريح، تكون القيمة المفترضة هي DefaultTimeToLive لقائمة الانتظار أو الموضوع المعني. لا يمكن أن تكون قيمة timeToLive على مستوى الرسالة أطول من إعداد DefaultTimeToLive للكيان ويتم ضبطها بصمت إذا كانت كذلك. راجع انتهاء الصلاحية.
to

العنوان "إلى". هذه الخاصية محجوزة للاستخدام المستقبلي في سيناريوهات التوجيه ويتم تجاهلها حاليا من قبل الوسيط نفسه. يمكن للتطبيقات استخدام هذه القيمة في سيناريوهات التسلسل التلقائي المستندة إلى القواعد للإشارة إلى الوجهة المنطقية المقصودة للرسالة.

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

applicationProperties

الخصائص الخاصة بالتطبيق التي يمكن استخدامها لبيانات تعريف الرسائل المخصصة.

applicationProperties?: {[key: string]: number | boolean | string | Date | null}

قيمة الخاصية

{[key: string]: number | boolean | string | Date | null}

body

نص الرسالة الذي يجب إرساله أو تلقيه. إذا كان التطبيق الذي يتلقى الرسالة لا يستخدم SDK هذا، فحول حمولة النص الأساسي إلى صفيف بايت أو مخزن مؤقت للحصول على توافق أفضل عبر اللغات.

body: any

قيمة الخاصية

any

contentType

نوع محتوى الرسالة. يصف اختياريا حمولة الرسالة، مع واصف يتبع تنسيق RFC2045، القسم 5، على سبيل المثال "application/json".

contentType?: string

قيمة الخاصية

string

correlationId

معرف الارتباط الذي يسمح للتطبيق بتحديد سياق للرسالة لأغراض الارتباط، على سبيل المثال يعكس MessageId لرسالة يتم الرد عليها. راجع توجيه الرسائلالارتباط.

correlationId?: string | number | Buffer

قيمة الخاصية

string | number | Buffer

messageId

معرف الرسالة هو قيمة معرفة من قبل التطبيق تحدد الرسالة وحمولةها بشكل فريد.

ملاحظة: الأرقام غير الصحيحة غير الصحيحة غير مسموح بها.

messageId?: string | number | Buffer

قيمة الخاصية

string | number | Buffer

partitionKey

مفتاح القسم لإرسال رسالة إلى كيان مقسم. الحد الأقصى للطول هو 128 حرفا. بالنسبة الكيانات المقسمة، يتيح تعيين هذه القيمة تعيين الرسائل ذات الصلة لنفس القسم الداخلي، بحيث يتم تسجيل ترتيب تسلسل الإرسال بشكل صحيح. يتم اختيار القسم بواسطة دالة تجزئة على هذه القيمة ولا يمكن اختياره مباشرة.

  • بالنسبة للكيانات المدركة للجلسة، تتجاوز خاصية sessionId هذه القيمة.
  • بالنسبة للكيانات غير المقسمة، سيتم تجاهل مفتاح القسم
partitionKey?: string

قيمة الخاصية

string

replyTo

عنوان كيان لإرسال الردود إليه. هذه القيمة الاختيارية والمعرفة بالتطبيق هي طريقة قياسية للتعبير عن مسار الرد على مستقبل الرسالة. عندما يتوقع المرسل ردا، فإنه يعين القيمة إلى المسار المطلق أو النسبي لقائمة الانتظار أو الموضوع الذي يتوقع إرسال الرد إليه. راجع توجيه الرسائلالارتباط.

replyTo?: string

قيمة الخاصية

string

replyToSessionId

معرف الجلسة الذي يزيد من عنوان replyTo. الحد الأقصى للطول هو 128 حرفا. تزيد هذه القيمة من معلومات ReplyTo وتحدد SessionId الذي يجب تعيينه للرد عند إرساله إلى كيان الرد. راجع توجيه الرسائلالارتباط.

replyToSessionId?: string

قيمة الخاصية

string

scheduledEnqueueTimeUtc

التاريخ والوقت في التوقيت العالمي المتفق عليه الذي سيتم فيه ترتيب الرسالة في قائمة الانتظار. ترجع هذه الخاصية الوقت بالتوقيت العالمي المتفق عليه؛ عند تعيين الخاصية، يجب أن تكون قيمة DateTime المتوفرة أيضا بالتوقيت العالمي المتفق عليه. هذه القيمة مخصصة لإرسال الرسائل المتأخرة. يتم استخدامه لتأخير إرسال الرسائل إلى وقت محدد في المستقبل. لا يعني وقت ترتيب الرسائل في قائمة الانتظار أنه سيتم إرسال الرسالة في نفس الوقت. سيتم وضعها في قائمة الانتظار، ولكن وقت الإرسال الفعلي يعتمد على حمل عمل قائمة الانتظار وحالتها.

scheduledEnqueueTimeUtc?: Date

قيمة الخاصية

Date

sessionId

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

sessionId?: string

قيمة الخاصية

string

subject

التسمية الخاصة بالتطبيق. تمكن هذه الخاصية التطبيق من الإشارة إلى الغرض من الرسالة إلى المتلقي في معيار. أزياء، على غرار سطر موضوع البريد الإلكتروني. الخاصية AMQP المعينة هي "الموضوع".

subject?: string

قيمة الخاصية

string

timeToLive

وقت الرسالة للقيمة المباشرة. هذه القيمة هي المدة النسبية التي تنتهي بعدها صلاحية الرسالة، بدءا من لحظة قبول الرسالة وتخزينها من قبل الوسيط، كما تم التقاطها في enqueuedTimeUtc. عند عدم التعيين بشكل صريح، تكون القيمة المفترضة هي DefaultTimeToLive لقائمة الانتظار أو الموضوع المعني. لا يمكن أن تكون قيمة timeToLive على مستوى الرسالة أطول من إعداد DefaultTimeToLive للكيان ويتم ضبطها بصمت إذا كانت كذلك. راجع انتهاء الصلاحية.

timeToLive?: number

قيمة الخاصية

number

to

العنوان "إلى". هذه الخاصية محجوزة للاستخدام المستقبلي في سيناريوهات التوجيه ويتم تجاهلها حاليا من قبل الوسيط نفسه. يمكن للتطبيقات استخدام هذه القيمة في سيناريوهات التسلسل التلقائي المستندة إلى القواعد للإشارة إلى الوجهة المنطقية المقصودة للرسالة.

to?: string

قيمة الخاصية

string