مشاركة عبر


@azure/service-bus package

الفصول

MessagingError

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

ServiceBusAdministrationClient

ترجع جميع العمليات الوعود التي يتم حلها إلى كائن يحتوي على الإخراج ذي الصلة. تحتوي هذه الكائنات أيضا على خاصية تسمى _response يمكنك استخدامها إذا كنت تريد الوصول إلى الاستجابة المباشرة من الخدمة.

ServiceBusClient

عميل يمكنه إنشاء مثيلات المرسل لإرسال الرسائل إلى قوائم الانتظار والموضوعات بالإضافة إلى مثيلات المتلقي لتلقي الرسائل من قوائم الانتظار والاشتراكات.

ServiceBusError

الأخطاء التي تحدث داخل ناقل خدمة Microsoft Azure.

الواجهات

AuthorizationRule

يمثل نوع AuthorizationRule في عمليات الإدارة المستندة إلى ATOM.

CorrelationRuleFilter

يمثل تعبير عامل تصفية الارتباط. يحتوي CorrelationRuleFilter على مجموعة من الشروط التي تتم مطابقتها مع خصائص المستخدم والنظام للرسائل الواردة من اشتراك.

CreateMessageBatchOptions

خيارات لتكوين أسلوب createBatch على Sender.

  • maxSizeInBytes: الحد الأعلى لحجم الدفعة.

مثال على الاستخدام:

{
    maxSizeInBytes: 1024 * 1024 // 1 MB
}
CreateQueueOptions

يمثل خيارات settable في قائمة انتظار

CreateSubscriptionOptions

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

CreateTopicOptions

يمثل خيارات settable في موضوع

DeadLetterOptions

توضح هذه المقالة سبب ووصف الخطأ لرسائل غير مستخدمة باستخدام أسلوب deadLetter() على الرسالة المستلمة من ناقل خدمة Microsoft Azure.

Delivery
GetMessageIteratorOptions

خيارات عند الحصول على مكرر قابل للتكارات من ناقل خدمة Microsoft Azure.

HttpHeader

رأس فردي ضمن مجموعة HttpHeaders.

HttpHeadersLike

مجموعة من أزواج مفتاح/قيمة عنوان HTTP.

HttpResponse

الخصائص على استجابة HTTP التي ستكون موجودة دائما.

MessageHandlers

واجهة معالج الرسائل العامة (المستخدمة ل streamMessages).

NamespaceProperties

يمثل بيانات التعريف المتعلقة بمساحة اسم ناقل الخدمة.

OperationOptions

نوع الخيارات الأساسية لكافة العمليات.

PeekMessagesOptions

يصف الخيارات التي تم تمريرها إلى أسلوب peekMessages على جهاز استقبال.

ProcessErrorArgs

وسيطات رد الاتصال processError.

QueueProperties

يمثل الإدخال ل updateQueue.

QueueRuntimeProperties

يمثل سمات معلومات وقت التشغيل الخاصة بكيان قائمة انتظار

ReceiveMessagesOptions

خيارات عند تلقي دفعة من الرسائل من ناقل خدمة Microsoft Azure.

RetryOptions

خيارات نهج إعادة المحاولة التي تحدد الوضع وعدد مرات إعادة المحاولة والفاصل الزمني لإعادة المحاولة وما إلى ذلك.

RuleProperties

يمثل جميع سمات القاعدة.

ServiceBusAdministrationClientOptions

يمثل خيارات العميل ServiceBusAdministrationClient.

ServiceBusClientOptions

توضح هذه المقالة الخيارات التي يمكن توفيرها أثناء إنشاء ServiceBusClient.

  • webSocketOptions : خيارات لتكوين قناة اتصال AMQP عبر مآخذ ويب.
    • websocket : الدالة الإنشائية WebSocket المستخدمة لإنشاء اتصال AMQP إذا اخترت إجراء الاتصال عبر WebSocket.
    • webSocketConstructorOptions : خيارات لتمريرها إلى الدالة الإنشائية Websocket عند اختيار إجراء الاتصال عبر WebSocket.
  • retryOptions : خيارات إعادة المحاولة لجميع العمليات على العميل.
    • maxRetries : عدد المرات التي يمكن فيها إعادة محاولة العملية في حالة حدوث خطأ قابل لإعادة المحاولة.
    • maxRetryDelayInMs: الحد الأقصى للتأخير بين عمليات إعادة المحاولة. ينطبق فقط عند إجراء عمليات إعادة المحاولة الأسية.
    • mode: وضع إعادة المحاولة الذي يجب تطبيقه، المحدد بواسطة قائمة تعداد RetryMode. الخيارات هي ExponentialFixed. الإعدادات الافتراضية Fixed.
    • retryDelayInMs: مقدار الوقت للانتظار بالمللي ثانية قبل إجراء المحاولة التالية. عند تعيين mode إلى Exponential، يتم استخدام هذا لحساب التأخيرات المتزايدة بشكل كبير بين عمليات إعادة المحاولة. الافتراضي: 30000 مللي ثانية.
    • timeoutInMs: مقدار الوقت بالمللي ثانية للانتظار قبل انتهاء مهلة العملية. سيؤدي هذا إلى إعادة المحاولة إذا كانت هناك أي محاولات إعادة محاولة متبقية. الحد الأدنى للقيمة: 60000 مللي ثانية.
ServiceBusConnectionStringProperties

مجموعة الخصائص التي تشكل سلسلة اتصال ناقل خدمة Microsoft Azure.

ServiceBusMessage

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

ServiceBusMessageBatch

دفعة من الرسائل التي يمكنك إنشاؤها باستخدام أسلوب <xref:createBatch>.

ServiceBusReceivedMessage

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

ServiceBusReceiver

جهاز استقبال لا يتعامل مع جلسات العمل.

ServiceBusReceiverOptions

خيارات لاستخدامها عند إنشاء جهاز استقبال.

ServiceBusRuleManager

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

ServiceBusSender

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

ServiceBusSenderOptions

خيارات لاستخدامها عند إنشاء مرسل.

ServiceBusSessionReceiver

جهاز استقبال يعالج جلسات العمل، بما في ذلك تجديد تأمين الجلسة.

ServiceBusSessionReceiverOptions

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

SqlRuleFilter

يمثل جميع الحقول الممكنة على SqlRuleFilter

SubscribeOptions

الخيارات المستخدمة عند الاشتراك في قائمة انتظار أو اشتراك ناقل خدمة Microsoft Azure.

SubscriptionProperties

يمثل إدخال updateSubscription.

SubscriptionRuntimeProperties

يمثل سمات معلومات وقت التشغيل الخاصة بكيان اشتراك

TokenCredential

يمثل بيانات اعتماد قادرة على توفير رمز مميز للمصادقة.

TopicProperties

يمثل الإدخال ل updateTopic.

TopicRuntimeProperties

يمثل سمات معلومات وقت التشغيل الخاصة بكيان موضوع

TryAddOptions

مجموعة الخيارات لنشر سياق Span يدويا للتتبع الموزع.

WebResourceLike

وصف لطلب HTTP الذي سيتم إجراؤه إلى خادم بعيد.

WebSocketImpl

يصف الشكل المطلوب من منشئات WebSocket.

WebSocketOptions

خيارات لتكوين قناة اتصال AMQP عبر مآخذ ويب.

النوع أسماء مستعارة

EntitiesResponse

يمثل نتيجة عملية القائمة على الكيانات التي تحتوي أيضا على continuationToken لبدء التكرار من.

EntityAvailabilityStatus

القيم المحتملة availabilityStatus لكيانات مراسلة ناقل خدمة Microsoft Azure.

EntityStatus

القيم المحتملة status لكيانات مراسلة ناقل خدمة Microsoft Azure.

OperationOptionsBase

ملاحظة: يهدف هذا النوع إلى عكس الحقول والبنية ذات الصلة من @azure/core-client OperationOptions

خيارات لتكوين التتبع و abortSignal.

RawHttpHeaders

يتم تمثيل مجموعة HttpHeaders ككائن JSON بسيط.

ServiceBusErrorCode

رموز فشل ناقل خدمة Microsoft Azure.

SqlRuleAction

يمثل جميع الحقول الممكنة على SqlRuleAction

TransferProgressEvent

تم إطلاقه استجابة للتقدم في التحميل أو التنزيل.

WithResponse

يمثل الاستجابة التي تم إرجاعها للعملية جنبا إلى جنب مع الاستجابة الأولية.

التعدادات

RetryMode

يصف نوع وضع إعادة المحاولة

TokenType

يصف نوع الرموز المميزة المدعومة.

الوظائف

delay<T>(number, AbortSignalLike, string, T)

برنامج تضمين ل setTimeout الذي يحل الوعد بعد t مللي ثانية.

isServiceBusError(unknown)

تحديد ما إذا كان الخطأ من النوع ServiceBusError

parseServiceBusConnectionString(string)

تحليلات معينة لسلسلة الاتصال في الخصائص المختلفة المطبقة على ناقل خدمة Microsoft Azure. الخصائص مفيدة لإنشاء ServiceBusClient.

تفاصيل الوظيفة

delay<T>(number, AbortSignalLike, string, T)

برنامج تضمين ل setTimeout الذي يحل الوعد بعد t مللي ثانية.

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

المعلمات

delayInMs

number

عدد المللي ثانية التي سيتم تأخيرها.

abortSignal
AbortSignalLike

abortSignal المقترن بعملية الاحتواء.

abortErrorMsg

string

رسالة الخطأ التي تم إجهاضها المقترنة بعملية الاحتواء.

value

T

القيمة التي سيتم حلها بعد انتهاء مهلة ميلي ثانية.

المرتجعات

Promise<T | void>

  • الوعد الذي تم حله

isServiceBusError(unknown)

تحديد ما إذا كان الخطأ من النوع ServiceBusError

function isServiceBusError(err: unknown): err

المعلمات

err

unknown

خطأ للتحقق لمعرفة ما إذا كان من نوع ServiceBusError

المرتجعات

err

parseServiceBusConnectionString(string)

تحليلات معينة لسلسلة الاتصال في الخصائص المختلفة المطبقة على ناقل خدمة Microsoft Azure. الخصائص مفيدة لإنشاء ServiceBusClient.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

المعلمات

connectionString

string

سلسلة الاتصال المقترنة بنهج الوصول المشترك التي تم إنشاؤها لمساحة اسم ناقل خدمة Microsoft Azure أو قائمة الانتظار أو الموضوع.

المرتجعات