ServiceBusReceivedMessage interface

الحزمة:

@azure/service-bus

يصف الرسالة المستلمة من ناقل خدمة Microsoft Azure أثناء عمليات النظرة الخاطفة وبالتالي لا يمكن تسويتها.

يمتد

ServiceBusMessage

الخصائص

deadLetterErrorDescription	وصف الخطأ لرسائل غير مميتة.
deadLetterReason	سبب تشويش الرسالة.
deadLetterSource	اسم قائمة الانتظار أو الاشتراك الذي تم وضع هذه الرسالة في قائمة الانتظار عليه، قبل أن يتم حذفها. قم بتعيين فقط في الرسائل التي تم حذفها ثم إعادة توجيهها تلقائيا من قائمة الانتظار الفرعية غير المستخدمة إلى كيان آخر. يشير إلى الكيان الذي تم فيه كتابة الرسالة غير المستخدمة.
deliveryCount	عدد عمليات التسليم التي تمت محاولة تنفيذها لهذه الرسالة. يتم زيادة العدد عند انتهاء صلاحية تأمين الرسالة، أو يتم التخلي عن الرسالة بشكل صريح باستخدام أسلوب abandon() على الرسالة.
enqueuedSequenceNumber	رقم التسلسل الأصلي للرسالة. بالنسبة للرسائل التي تمت إعادة توجيهها تلقائيا، تعكس هذه الخاصية رقم التسلسل الذي تم تعيينه للرسالة في نقطة إرسالها الأصلية.
enqueuedTimeUtc	لحظة UTC التي تم فيها قبول الرسالة وتخزينها في ناقل خدمة Microsoft Azure.
expiresAtUtc	لحظة UTC التي تم وضع علامة على الرسالة لإزالتها ولم تعد متاحة للاسترداد من الكيان بسبب انتهاء الصلاحية. يتم حساب هذه الخاصية من خاصيتين أخريين على الرسالة: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	لحظة UTC حتى يتم الاحتفاظ بالرسالة مؤمنة في قائمة الانتظار/الاشتراك. عند انتهاء صلاحية التأمين، يتم زيادة deliveryCount وتتوفر الرسالة مرة أخرى للاسترداد. لا ينطبق عند تلقي الرسالة في receiveAndDelete وضع الاستلام. طريقة.
lockToken	رمز التأمين المميز هو مرجع إلى التأمين الذي يتم الاحتفاظ به من قبل الوسيط في وضع تلقي peekLock. يتم استخدام التأمينات داخليا لتسوية الرسائل كما هو موضح في وثائق المنتج بمزيد من التفصيل لا ينطبق عند تلقي الرسالة في receiveAndDelete وضع الاستلام. طريقة.
sequenceNumber	الرقم الفريد المعين لرسالة بواسطة ناقل خدمة Microsoft Azure. رقم التسلسل هو عدد صحيح فريد 64 بت تم تعيينه لرسالة حيث يتم قبولها وتخزينها من قبل الوسيط والوظائف كمعرف صحيح لها. بالنسبة للكيانات المقسمة، تعكس أعلى 16 بت معرف القسم. أرقام التسلسل تزداد بشكل رتيبة. يتم تمريرها إلى 0 عند استنفاد نطاق 48-64 بت. Max عدد صحيح آمن يدعمه Javascript حاليا هو 2^53 - 1. رقم التسلسل هو نوع AMQP Long الذي يمكن أن يصل إلى 64 بت. لتمثيل أننا نستخدم مكتبة تسمى long.js. نتوقع من العملاء استخدام نوع Long الذي تم تصديره بواسطة هذه المكتبة.
state	يمكن أن تكون حالة الرسالة نشطة أو مؤجلة أو مجدولة. الرسائل المؤجلة لها حالة مؤجلة، والرسائل المجدولة لها حالة مجدولة، وجميع الرسائل الأخرى لها حالة نشطة.

الخصائص الموروثة

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	العنوان "إلى". هذه الخاصية محجوزة للاستخدام المستقبلي في سيناريوهات التوجيه ويتم تجاهلها حاليا من قبل الوسيط نفسه. يمكن للتطبيقات استخدام هذه القيمة في سيناريوهات التسلسل التلقائي المستندة إلى القواعد للإشارة إلى الوجهة المنطقية المقصودة للرسالة.

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

deadLetterErrorDescription

وصف الخطأ لرسائل غير مميتة.

deadLetterErrorDescription?: string

قيمة الخاصية

string

deadLetterReason

سبب تشويش الرسالة.

deadLetterReason?: string

قيمة الخاصية

string

deadLetterSource

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

deadLetterSource?: string

قيمة الخاصية

string

deliveryCount

عدد عمليات التسليم التي تمت محاولة تنفيذها لهذه الرسالة. يتم زيادة العدد عند انتهاء صلاحية تأمين الرسالة، أو يتم التخلي عن الرسالة بشكل صريح باستخدام أسلوب abandon() على الرسالة.

deliveryCount?: number

قيمة الخاصية

number

enqueuedSequenceNumber

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

enqueuedSequenceNumber?: number

قيمة الخاصية

number

enqueuedTimeUtc

لحظة UTC التي تم فيها قبول الرسالة وتخزينها في ناقل خدمة Microsoft Azure.

enqueuedTimeUtc?: Date

قيمة الخاصية

Date

expiresAtUtc

لحظة UTC التي تم وضع علامة على الرسالة لإزالتها ولم تعد متاحة للاسترداد من الكيان بسبب انتهاء الصلاحية. يتم حساب هذه الخاصية من خاصيتين أخريين على الرسالة: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

قيمة الخاصية

Date

lockedUntilUtc

لحظة UTC حتى يتم الاحتفاظ بالرسالة مؤمنة في قائمة الانتظار/الاشتراك. عند انتهاء صلاحية التأمين، يتم زيادة deliveryCount وتتوفر الرسالة مرة أخرى للاسترداد.

• لا ينطبق عند تلقي الرسالة في receiveAndDelete وضع الاستلام. طريقة.

lockedUntilUtc?: Date

قيمة الخاصية

Date

lockToken

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

• لا ينطبق عند تلقي الرسالة في receiveAndDelete وضع الاستلام. طريقة.

lockToken?: string

قيمة الخاصية

string

sequenceNumber

الرقم الفريد المعين لرسالة بواسطة ناقل خدمة Microsoft Azure. رقم التسلسل هو عدد صحيح فريد 64 بت تم تعيينه لرسالة حيث يتم قبولها وتخزينها من قبل الوسيط والوظائف كمعرف صحيح لها. بالنسبة للكيانات المقسمة، تعكس أعلى 16 بت معرف القسم. أرقام التسلسل تزداد بشكل رتيبة. يتم تمريرها إلى 0 عند استنفاد نطاق 48-64 بت.

Max عدد صحيح آمن يدعمه Javascript حاليا هو 2^53 - 1. رقم التسلسل هو نوع AMQP Long الذي يمكن أن يصل إلى 64 بت. لتمثيل أننا نستخدم مكتبة تسمى long.js. نتوقع من العملاء استخدام نوع Long الذي تم تصديره بواسطة هذه المكتبة.

sequenceNumber?: Long

قيمة الخاصية

Long

state

يمكن أن تكون حالة الرسالة نشطة أو مؤجلة أو مجدولة. الرسائل المؤجلة لها حالة مؤجلة، والرسائل المجدولة لها حالة مجدولة، وجميع الرسائل الأخرى لها حالة نشطة.

state: "active" | "deferred" | "scheduled"

قيمة الخاصية

"active" | "deferred" | "scheduled"

تفاصيل الخاصية الموروثة

applicationProperties

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

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

قيمة الخاصية

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

موروث منServiceBusMessage.applicationProperties

body

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

body: any

قيمة الخاصية

any

موروث منServiceBusMessage.body

contentType

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

contentType?: string

قيمة الخاصية

string

موروث منServiceBusMessage.contentType

correlationId

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

correlationId?: string | number | Buffer

قيمة الخاصية

string | number | Buffer

موروث منServiceBusMessage.correlationId

messageId

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

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

messageId?: string | number | Buffer

قيمة الخاصية

string | number | Buffer

موروث منServiceBusMessage.messageId

partitionKey

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

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

partitionKey?: string

قيمة الخاصية

string

موروث منServiceBusMessage.partitionKey

replyTo

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

replyTo?: string

قيمة الخاصية

string

موروث منServiceBusMessage.replyTo

replyToSessionId

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

replyToSessionId?: string

قيمة الخاصية

string

موروث منServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

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

scheduledEnqueueTimeUtc?: Date

قيمة الخاصية

Date

موروث منServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

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

sessionId?: string

قيمة الخاصية

string

موروث منServiceBusMessage.sessionId

subject

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

subject?: string

قيمة الخاصية

string

موروث منServiceBusMessage.subject

timeToLive

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

timeToLive?: number

قيمة الخاصية

number

موروث منServiceBusMessage.timeToLive

to

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

to?: string

قيمة الخاصية

string

موروث منServiceBusMessage.to