ServiceBusClient class
عميل يمكنه إنشاء مثيلات المرسل لإرسال الرسائل إلى قوائم الانتظار والموضوعات بالإضافة إلى مثيلات المتلقي لتلقي الرسائل من قوائم الانتظار والاشتراكات.
المنشئون
| Service |
إنشاء مثيل لفئة ServiceBusClient التي يمكن استخدامها لإنشاء المرسلين والمستلمين إلى مساحة اسم ناقل خدمة Microsoft Azure المتوفرة في سلسلة الاتصال. لا يتم إجراء أي اتصال بالخدمة حتى يتم استخدام المرسلين/المستلمين الذين تم إنشاؤهم مع العميل لإرسال/تلقي الرسائل. |
| Service |
إنشاء مثيل فئة ServiceBusClient التي يمكن استخدامها لإنشاء المرسلين والمستلمين إلى مساحة اسم ناقل خدمة Microsoft Azure المتوفرة. لا يتم إجراء أي اتصال بالخدمة حتى يتم استخدام المرسلين/المستلمين الذين تم إنشاؤهم مع العميل لإرسال/تلقي الرسائل. |
الخصائص
| fully |
مساحة الاسم المؤهلة بالكامل لمثيل ناقل خدمة Microsoft Azure الذي تم إنشاء هذا العميل له. من المحتمل أن يكون هذا مشابها ل <yournamespace.servicebus.windows.net>. |
| identifier | الاسم المستخدم لتعريف ServiceBusClient هذا. إذا لم يتم تحديده أو إفراغه، إنشاء واحد فريد عشوائي. |
الأساليب
| accept |
إنشاء جهاز استقبال لجلسة العمل المتوفرة التالية في قائمة انتظار ناقل خدمة Azure الممكنة للجلسة. يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي. مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
| accept |
إنشاء جهاز استقبال لجلسة العمل المتوفرة التالية في اشتراك ناقل خدمة Azure الممكن لجلسة العمل. يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي. مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
| accept |
إنشاء جهاز استقبال لقائمة انتظار ناقل خدمة Azure الممكنة لجلسة العمل. يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي. مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
| accept |
إنشاء جهاز استقبال لاشتراك ناقل خدمة Azure الممكن لجلسة العمل. يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي. مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
| close() | إغلاق اتصال AMQP الأساسي. ملاحظة: سيؤدي هذا أيضا إلى قطع اتصال أي مثيلات المتلقي أو المرسل التي تم إنشاؤها من هذا المثيل. |
| create |
إنشاء جهاز استقبال لقائمة انتظار ناقل خدمة Microsoft Azure. لا يتم إجراء أي اتصال بالخدمة حتى يتم استدعاء إحدى الطرق على المتلقي. لاستهداف قوائم الانتظار الفرعية مثل قائمة انتظار الأحرف غير المستخدمة أو قائمة انتظار نقل الرسائل غير المستخدمة، قم بتوفير يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
ستتم إعادة تسليم الرسائل التي لم تتم تسويتها خلال مدة التأمين عدة مرات مثل الحد الأقصى لعدد التسليم المحدد في قائمة الانتظار، وبعد ذلك يتم إرسالها إلى قائمة انتظار منفصلة غير مستخدمة. يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي. مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
| create |
إنشاء جهاز استقبال لاشتراك ناقل خدمة Microsoft Azure. لا يتم إجراء أي اتصال بالخدمة حتى يتم استدعاء إحدى الطرق على المتلقي. لاستهداف قوائم الانتظار الفرعية مثل قائمة انتظار الأحرف غير المستخدمة أو قائمة انتظار نقل الرسائل غير المستخدمة، قم بتوفير يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
ستتم إعادة تسليم الرسائل التي لم تتم تسويتها خلال مدة التأمين عدة مرات مثل الحد الأقصى لعدد التسليم المعين على الاشتراك، وبعد ذلك يتم إرسالها إلى قائمة انتظار منفصلة غير مستخدمة. يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي. مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
| create |
إنشاء مثيل ServiceBusRuleManager المستخدمة لإدارة قواعد الاشتراك. |
| create |
إنشاء مرسل يمكن استخدامه لإرسال الرسائل وجدولة الرسائل لإرسالها في وقت لاحق وإلغاء هذه الرسائل المجدولة. لا يتم إجراء أي اتصال بالخدمة حتى يتم استدعاء إحدى الطرق على المرسل. |
تفاصيل المنشئ
ServiceBusClient(string, ServiceBusClientOptions)
إنشاء مثيل لفئة ServiceBusClient التي يمكن استخدامها لإنشاء المرسلين والمستلمين إلى مساحة اسم ناقل خدمة Microsoft Azure المتوفرة في سلسلة الاتصال. لا يتم إجراء أي اتصال بالخدمة حتى يتم استخدام المرسلين/المستلمين الذين تم إنشاؤهم مع العميل لإرسال/تلقي الرسائل.
new ServiceBusClient(connectionString: string, options?: ServiceBusClientOptions)
المعلمات
- connectionString
-
string
سلسلة اتصال لمساحة اسم ناقل خدمة Microsoft Azure. ملاحظة: يمكن أن تحتوي سلسلة الاتصال هذه على EntityPath، والذي يتم تجاهله.
- options
- ServiceBusClientOptions
خيارات لعميل ناقل الخدمة.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)
إنشاء مثيل فئة ServiceBusClient التي يمكن استخدامها لإنشاء المرسلين والمستلمين إلى مساحة اسم ناقل خدمة Microsoft Azure المتوفرة. لا يتم إجراء أي اتصال بالخدمة حتى يتم استخدام المرسلين/المستلمين الذين تم إنشاؤهم مع العميل لإرسال/تلقي الرسائل.
new ServiceBusClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: ServiceBusClientOptions)
المعلمات
- fullyQualifiedNamespace
-
string
مساحة الاسم الكاملة لمثيل ناقل خدمة Microsoft Azure الخاص بك والتي من المحتمل أن تكون مشابهة ل <yournamespace.servicebus.windows.net>.
- credential
كائن بيانات اعتماد يستخدمه العميل للحصول على الرمز المميز لمصادقة الاتصال مع ناقل خدمة Microsoft Azure. راجع @azure/الهوية لإنشاء بيانات الاعتماد.
إذا كنت تستخدم تنفيذا خاصا لواجهة TokenCredential مقابل AAD، فقم بتعيين "النطاقات" لناقل الخدمة ليتم ["https://servicebus.azure.net//user_impersonation"] للحصول على الرمز المميز المناسب.
استخدم AzureNamedKeyCredential من @azure/core-auth إذا كنت تريد تمرير SharedAccessKeyNameSharedAccessKey دون استخدام سلسلة اتصال. تعين هذه الحقول إلى الحقلين namekey على التوالي في AzureNamedKeyCredential.
استخدم AzureSASCredential من @azure/core-auth إذا كنت تريد تمرير SharedAccessSignature دون استخدام سلسلة اتصال. يعين هذا الحقل إلى signature في AzureSASCredential.
- options
- ServiceBusClientOptions
مجموعة من الخيارات لتطبيقها عند تكوين العميل.
-
retryOptions: تكوين نهج إعادة المحاولة لجميع العمليات على العميل. على سبيل المثال،{ "maxRetries": 4 }أو{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: تكوين قناة اتصال AMQP عبر مآخذ ويب.
تفاصيل الخاصية
fullyQualifiedNamespace
مساحة الاسم المؤهلة بالكامل لمثيل ناقل خدمة Microsoft Azure الذي تم إنشاء هذا العميل له. من المحتمل أن يكون هذا مشابها ل <yournamespace.servicebus.windows.net>.
fullyQualifiedNamespace: string
قيمة الخاصية
string
identifier
الاسم المستخدم لتعريف ServiceBusClient هذا. إذا لم يتم تحديده أو إفراغه، إنشاء واحد فريد عشوائي.
identifier: string
قيمة الخاصية
string
تفاصيل الأسلوب
acceptNextSession(string, ServiceBusSessionReceiverOptions)
إنشاء جهاز استقبال لجلسة العمل المتوفرة التالية في قائمة انتظار ناقل خدمة Azure الممكنة للجلسة.
يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
- في وضع peekLock، يكون لدى المتلقي تأمين على الرسالة للمدة المحددة في قائمة الانتظار.
- في وضع receiveAndDelete، يتم حذف الرسائل من ناقل خدمة Microsoft Azure عند تلقيها.
يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي.
مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
function acceptNextSession(queueName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>
المعلمات
- queueName
-
string
اسم قائمة الانتظار التي تريد الاستلام منها.
- options
- ServiceBusSessionReceiverOptions
تتضمن الخيارات receiveMode (الافتراضي إلى peekLock)، خيارات لإنشاء جهاز استقبال جلسة عمل.
المرتجعات
Promise<ServiceBusSessionReceiver>
جهاز استقبال يمكن استخدامه لتلقي الرسائل وإلق نظرة خاطفة عليها وتسويتها.
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)
إنشاء جهاز استقبال لجلسة العمل المتوفرة التالية في اشتراك ناقل خدمة Azure الممكن لجلسة العمل.
يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
- في وضع peekLock، يكون لدى المتلقي تأمين على الرسالة للمدة المحددة في قائمة الانتظار.
- في وضع receiveAndDelete، يتم حذف الرسائل من ناقل خدمة Microsoft Azure عند تلقيها.
يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي.
مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
function acceptNextSession(topicName: string, subscriptionName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>
المعلمات
- topicName
-
string
اسم الموضوع للاشتراك الذي نريد تلقيه منه.
- subscriptionName
-
string
اسم الاشتراك (ضمن topic) الذي نريد تلقيه منه.
- options
- ServiceBusSessionReceiverOptions
تتضمن الخيارات receiveMode (الافتراضي إلى peekLock)، خيارات لإنشاء جهاز استقبال جلسة عمل.
المرتجعات
Promise<ServiceBusSessionReceiver>
جهاز استقبال يمكن استخدامه لتلقي الرسائل وإلق نظرة خاطفة عليها وتسويتها.
acceptSession(string, string, ServiceBusSessionReceiverOptions)
إنشاء جهاز استقبال لقائمة انتظار ناقل خدمة Azure الممكنة لجلسة العمل.
يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
- في وضع peekLock، يكون لدى المتلقي تأمين على الرسالة للمدة المحددة في قائمة الانتظار.
- في وضع receiveAndDelete، يتم حذف الرسائل من ناقل خدمة Microsoft Azure عند تلقيها.
يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي.
مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
function acceptSession(queueName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>
المعلمات
- queueName
-
string
اسم قائمة الانتظار التي تريد الاستلام منها.
- sessionId
-
string
معرف الجلسة التي يجب تلقي الرسائل منها
- options
- ServiceBusSessionReceiverOptions
تتضمن الخيارات receiveMode (الافتراضي إلى peekLock)، خيارات لإنشاء جهاز استقبال جلسة عمل.
المرتجعات
Promise<ServiceBusSessionReceiver>
جهاز استقبال يمكن استخدامه لتلقي الرسائل وإلق نظرة خاطفة عليها وتسويتها.
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)
إنشاء جهاز استقبال لاشتراك ناقل خدمة Azure الممكن لجلسة العمل.
يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
- في وضع peekLock، يكون لدى المتلقي تأمين على الرسالة للمدة المحددة في قائمة الانتظار.
- في وضع receiveAndDelete، يتم حذف الرسائل من ناقل خدمة Microsoft Azure عند تلقيها.
يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي.
مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
function acceptSession(topicName: string, subscriptionName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>
المعلمات
- topicName
-
string
اسم الموضوع للاشتراك الذي نريد تلقيه منه.
- subscriptionName
-
string
اسم الاشتراك (ضمن topic) الذي نريد تلقيه منه.
- sessionId
-
string
معرف الجلسة التي يجب تلقي الرسائل منها
- options
- ServiceBusSessionReceiverOptions
تتضمن الخيارات receiveMode (الافتراضي إلى peekLock)، خيارات لإنشاء جهاز استقبال جلسة عمل.
المرتجعات
Promise<ServiceBusSessionReceiver>
جهاز استقبال يمكن استخدامه لتلقي الرسائل وإلق نظرة خاطفة عليها وتسويتها.
close()
إغلاق اتصال AMQP الأساسي. ملاحظة: سيؤدي هذا أيضا إلى قطع اتصال أي مثيلات المتلقي أو المرسل التي تم إنشاؤها من هذا المثيل.
function close(): Promise<void>
المرتجعات
Promise<void>
createReceiver(string, ServiceBusReceiverOptions)
إنشاء جهاز استقبال لقائمة انتظار ناقل خدمة Microsoft Azure. لا يتم إجراء أي اتصال بالخدمة حتى يتم استدعاء إحدى الطرق على المتلقي.
لاستهداف قوائم الانتظار الفرعية مثل قائمة انتظار الأحرف غير المستخدمة أو قائمة انتظار نقل الرسائل غير المستخدمة، قم بتوفير subQueue في الخيارات. لمعرفة المزيد حول قوائم انتظار الرسائل غير المستخدمة، راجع https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
- في وضع peekLock، يكون لدى المتلقي تأمين على الرسالة للمدة المحددة في قائمة الانتظار.
- في وضع receiveAndDelete، يتم حذف الرسائل من ناقل خدمة Microsoft Azure عند تلقيها.
ستتم إعادة تسليم الرسائل التي لم تتم تسويتها خلال مدة التأمين عدة مرات مثل الحد الأقصى لعدد التسليم المحدد في قائمة الانتظار، وبعد ذلك يتم إرسالها إلى قائمة انتظار منفصلة غير مستخدمة.
يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي.
مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
function createReceiver(queueName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver
المعلمات
- queueName
-
string
اسم قائمة الانتظار التي تريد الاستلام منها.
- options
- ServiceBusReceiverOptions
خيارات لتمرير receiveMode، افتراضيا إلى peekLock.
المرتجعات
جهاز استقبال يمكن استخدامه لتلقي الرسائل وإلق نظرة خاطفة عليها وتسويتها.
createReceiver(string, string, ServiceBusReceiverOptions)
إنشاء جهاز استقبال لاشتراك ناقل خدمة Microsoft Azure. لا يتم إجراء أي اتصال بالخدمة حتى يتم استدعاء إحدى الطرق على المتلقي.
لاستهداف قوائم الانتظار الفرعية مثل قائمة انتظار الأحرف غير المستخدمة أو قائمة انتظار نقل الرسائل غير المستخدمة، قم بتوفير subQueue في الخيارات. لمعرفة المزيد حول قوائم انتظار الرسائل غير المستخدمة، راجع https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
يمكنك الاختيار بين وضعي تلقي: "peekLock" (افتراضي) و"receiveAndDelete".
- في وضع peekLock، يكون لدى المتلقي تأمين على الرسالة للمدة المحددة في قائمة الانتظار.
- في وضع receiveAndDelete، يتم حذف الرسائل من ناقل خدمة Microsoft Azure عند تلقيها.
ستتم إعادة تسليم الرسائل التي لم تتم تسويتها خلال مدة التأمين عدة مرات مثل الحد الأقصى لعدد التسليم المعين على الاشتراك، وبعد ذلك يتم إرسالها إلى قائمة انتظار منفصلة غير مستخدمة.
يمكنك تسوية رسالة عن طريق استدعاء completeMessage()، أو abandonMessage()، أو deferMessage() أو طرق deadletterMessage() على المتلقي.
مزيد من المعلومات حول كيفية عمل peekLock وتسوية الرسائل هنا: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
function createReceiver(topicName: string, subscriptionName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver
المعلمات
- topicName
-
string
اسم الموضوع للاشتراك الذي نريد تلقيه منه.
- subscriptionName
-
string
اسم الاشتراك (ضمن topic) الذي نريد تلقيه منه.
- options
- ServiceBusReceiverOptions
خيارات لتمرير receiveMode، افتراضيا إلى peekLock.
المرتجعات
جهاز استقبال يمكن استخدامه لتلقي الرسائل وإلق نظرة خاطفة عليها وتسويتها.
createRuleManager(string, string)
إنشاء مثيل ServiceBusRuleManager المستخدمة لإدارة قواعد الاشتراك.
function createRuleManager(topicName: string, subscriptionName: string): ServiceBusRuleManager
المعلمات
- topicName
-
string
الموضوع لإنشاء ServiceBusRuleManager
- subscriptionName
-
string
الاشتراك الخاص بالموضوع المحدد لإنشاء ServiceBusRuleManager.
المرتجعات
نطاق ServiceBusRuleManager للاشتراك والموضوع المحددين.
createSender(string, ServiceBusSenderOptions)
إنشاء مرسل يمكن استخدامه لإرسال الرسائل وجدولة الرسائل لإرسالها في وقت لاحق وإلغاء هذه الرسائل المجدولة. لا يتم إجراء أي اتصال بالخدمة حتى يتم استدعاء إحدى الطرق على المرسل.
function createSender(queueOrTopicName: string, options?: ServiceBusSenderOptions): ServiceBusSender
المعلمات
- queueOrTopicName
-
string
اسم قائمة انتظار أو موضوع لإرسال رسائل إليه.
- options
- ServiceBusSenderOptions