CreateSubscriptionOptions interface

الحزمة:

@azure/service-bus

يمثل خيارات settable على اشتراك

يمتد

OperationOptions

الخصائص

autoDeleteOnIdle	الحد الأقصى لوقت الخمول قبل حذف الكيان. سيتم تحديد هذا بتنسيق مدة ISO-8601 مثل "PT1M" لمدة دقيقة واحدة، و"PT5S" لمدة 5 ثوان. المزيد حول تنسيق مدة ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus	حالة توفر كيان المراسلة.
deadLetteringOnFilterEvaluationExceptions	تحديد كيفية معالجة ناقل خدمة Microsoft Azure لرسالة تتسبب في استثناء أثناء تقييم عامل تصفية الاشتراك. إذا تم تعيين القيمة إلى true، نقل الرسالة التي تسببت في الاستثناء إلى قائمة الانتظار الفرعية غير المستخدمة للاشتراك. وإلا، سيتم تجاهله. بشكل افتراضي، يتم تعيين هذه المعلمة إلى true، مما يسمح للمستخدم بفرصة للتحقيق في سبب الاستثناء. يمكن أن يحدث من رسالة مشوهة أو بعض الافتراضات غير الصحيحة التي يتم إجراؤها في عامل التصفية حول شكل الرسالة. Settable فقط في وقت إنشاء الموضوع.
deadLetteringOnMessageExpiration	إذا تم تمكينها وانتهاء صلاحية رسالة، ينقل ناقل خدمة Microsoft Azure الرسالة من قائمة الانتظار إلى قائمة الانتظار الفرعية غير المستخدمة للاشتراك. إذا تم تعطيلها، حذف الرسالة نهائيا من قائمة الانتظار الرئيسية للاشتراك. Settable فقط في وقت إنشاء الاشتراك.
defaultMessageTimeToLive	تحديد المدة التي تستغرقها الرسالة في الاشتراك. استنادا إلى ما إذا كان قد تم تمكين الكتابة غير المستخدمة، سيتم نقل الرسالة التي انتهت صلاحية TTL الخاصة بها إلى DeadLtterQueue المرتبط بالاشتراك أو حذفها نهائيا. سيتم تحديد هذا بتنسيق مدة ISO-8601 مثل "PT1M" لمدة دقيقة واحدة، و"PT5S" لمدة 5 ثوان. المزيد حول تنسيق مدة ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultRuleOptions	يمثل خيارات إنشاء القاعدة الافتراضية للاشتراك.
enableBatchedOperations	يحدد ما إذا كان يجب السماح بالعمليات المجمعة.
forwardDeadLetteredMessagesTo	عنوان URL المطلق أو اسم قائمة الانتظار أو الموضوع الذي سيتم إعادة توجيه الرسائل غير المستخدمة إليه. على سبيل المثال، سيكون إدخال عنوان URL المطلق من النموذج sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo	عنوان URL المطلق أو اسم قائمة الانتظار أو الموضوع الذي سيتم إعادة توجيه الرسائل إليه. على سبيل المثال، سيكون إدخال عنوان URL المطلق من النموذج sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration	يتم تطبيق مدة التأمين الافتراضية على الاشتراكات التي لا تحدد مدة التأمين. (إذا تم تمكين جلسات العمل، فإن مدة التأمين هذه تنطبق على جلسات العمل وليس على الرسائل.) سيتم تحديد هذا بتنسيق مدة ISO-8601 مثل "PT1M" لمدة دقيقة واحدة، و"PT5S" لمدة 5 ثوان. المزيد حول تنسيق مدة ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount	يتم نقل الحد الأقصى لعدد تسليم الرسائل بعد ذلك إذا لم يتم تسويتها بعد، إلى قائمة الانتظار الفرعية غير المستخدمة.
requiresSession	إذا تم تعيينه إلى صحيح، فسيكون الاشتراك على علم بجلسة العمل وسيتم دعم SessionReceiver فقط. الاشتراك المدرك للجلسة غير مدعوم من خلال REST. Settable فقط في وقت إنشاء الاشتراك.
status	حالة كيان المراسلة.
userMetadata	قدم المستخدم معلومات بيانات التعريف المقترنة بالاشتراك. يستخدم لتحديد محتوى نصي مثل العلامات والتسميات وما إلى ذلك. يجب ألا تتجاوز القيمة 1024 بايت مرمزة في utf-8.

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

abortSignal	الإشارة التي يمكن استخدامها لإجهاض الطلبات.
onResponse	دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات.
requestOptions	الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية.
serializerOptions	خيارات لتجاوز سلوك التسلسل/إلغاء التسلسل.
tracingOptions	الخيارات المستخدمة عند تمكين التتبع.

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

autoDeleteOnIdle

الحد الأقصى لوقت الخمول قبل حذف الكيان. سيتم تحديد هذا بتنسيق مدة ISO-8601 مثل "PT1M" لمدة دقيقة واحدة، و"PT5S" لمدة 5 ثوان.

المزيد حول تنسيق مدة ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle?: string

قيمة الخاصية

string

availabilityStatus

حالة توفر كيان المراسلة.

availabilityStatus?: EntityAvailabilityStatus

قيمة الخاصية

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

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

deadLetteringOnFilterEvaluationExceptions?: boolean

قيمة الخاصية

boolean

deadLetteringOnMessageExpiration

إذا تم تمكينها وانتهاء صلاحية رسالة، ينقل ناقل خدمة Microsoft Azure الرسالة من قائمة الانتظار إلى قائمة الانتظار الفرعية غير المستخدمة للاشتراك. إذا تم تعطيلها، حذف الرسالة نهائيا من قائمة الانتظار الرئيسية للاشتراك. Settable فقط في وقت إنشاء الاشتراك.

deadLetteringOnMessageExpiration?: boolean

قيمة الخاصية

boolean

defaultMessageTimeToLive

تحديد المدة التي تستغرقها الرسالة في الاشتراك. استنادا إلى ما إذا كان قد تم تمكين الكتابة غير المستخدمة، سيتم نقل الرسالة التي انتهت صلاحية TTL الخاصة بها إلى DeadLtterQueue المرتبط بالاشتراك أو حذفها نهائيا. سيتم تحديد هذا بتنسيق مدة ISO-8601 مثل "PT1M" لمدة دقيقة واحدة، و"PT5S" لمدة 5 ثوان.

المزيد حول تنسيق مدة ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

قيمة الخاصية

string

defaultRuleOptions

يمثل خيارات إنشاء القاعدة الافتراضية للاشتراك.

defaultRuleOptions?: { action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

قيمة الخاصية

{ action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

enableBatchedOperations

يحدد ما إذا كان يجب السماح بالعمليات المجمعة.

enableBatchedOperations?: boolean

قيمة الخاصية

boolean

forwardDeadLetteredMessagesTo

عنوان URL المطلق أو اسم قائمة الانتظار أو الموضوع الذي سيتم إعادة توجيه الرسائل غير المستخدمة إليه. على سبيل المثال، سيكون إدخال عنوان URL المطلق من النموذج sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

قيمة الخاصية

string

forwardTo

عنوان URL المطلق أو اسم قائمة الانتظار أو الموضوع الذي سيتم إعادة توجيه الرسائل إليه. على سبيل المثال، سيكون إدخال عنوان URL المطلق من النموذج sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

قيمة الخاصية

string

lockDuration

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

سيتم تحديد هذا بتنسيق مدة ISO-8601 مثل "PT1M" لمدة دقيقة واحدة، و"PT5S" لمدة 5 ثوان.

المزيد حول تنسيق مدة ISO-8601: https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration?: string

قيمة الخاصية

string

maxDeliveryCount

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

maxDeliveryCount?: number

قيمة الخاصية

number

requiresSession

إذا تم تعيينه إلى صحيح، فسيكون الاشتراك على علم بجلسة العمل وسيتم دعم SessionReceiver فقط. الاشتراك المدرك للجلسة غير مدعوم من خلال REST. Settable فقط في وقت إنشاء الاشتراك.

requiresSession?: boolean

قيمة الخاصية

boolean

status

حالة كيان المراسلة.

status?: EntityStatus

قيمة الخاصية

EntityStatus

userMetadata

قدم المستخدم معلومات بيانات التعريف المقترنة بالاشتراك. يستخدم لتحديد محتوى نصي مثل العلامات والتسميات وما إلى ذلك. يجب ألا تتجاوز القيمة 1024 بايت مرمزة في utf-8.

userMetadata?: string

قيمة الخاصية

string

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

abortSignal

الإشارة التي يمكن استخدامها لإجهاض الطلبات.

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

موروث منOperationOptions.abortSignal

onResponse

دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات.

onResponse?: RawResponseCallback

قيمة الخاصية

RawResponseCallback

موروثة منOperationOptions.onResponse

requestOptions

الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية.

requestOptions?: OperationRequestOptions

قيمة الخاصية

OperationRequestOptions

موروثة منOperationOptions.requestOptions

serializerOptions

خيارات لتجاوز سلوك التسلسل/إلغاء التسلسل.

serializerOptions?: SerializerOptions

قيمة الخاصية

SerializerOptions

موروثة منOperationOptions.serializerOptions

tracingOptions

الخيارات المستخدمة عند تمكين التتبع.

tracingOptions?: OperationTracingOptions

قيمة الخاصية

OperationTracingOptions

موروث منOperationOptions.tracingOptions