CbsClient class

الحزمة:

@azure/core-amqp

يصف عميل EventHub/ServiceBus Cbs الذي يتحدث إلى نقطة نهاية $cbs عبر اتصال AMQP.

المنشئون

CbsClient(Connection, string)

الخصائص

cbsLock	اسم التأمين الفريد لكل جلسة $cbs لكل اتصال يتم استخدامه للحصول على التأمين لإنشاء جلسة عمل cbs إذا لم يكن أحدها موجودا لاتصال amqp.
connection	اتصال AMQP.
connectionLock	اسم التأمين الفريد لكل اتصال يستخدم للحصول على التأمين لإنشاء اتصال amqp إذا لم يكن موجودا.
endpoint	نقطة نهاية CBS - "$cbs"
replyTo	CBS replyTo - اسم ارتباط المتلقي الذي يجب أن ترد عليه الخدمة.

الأساليب

close()	إغلاق جلسة عمل AMQP cbs إلى EventHub/ServiceBus لهذا العميل، مع إرجاع وعد سيتم حله عند اكتمال قطع الاتصال.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })	إنشاء مثيل أحادي لجلسة عمل CBS إذا لم تتم تهيئته مسبقا على الاتصال المحدد.
isOpen()	يشير إلى ما إذا كان ارتباط مستقبل مرسل cbs مفتوحا أو مغلقا.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })	التفاوض على مطالبة CBS مع خدمة EventHub/ServiceBus.
remove()	يزيل جلسة عمل AMQP cbs إلى EventHub/ServiceBus لهذا العميل،

تفاصيل المنشئ

CbsClient(Connection, string)

new CbsClient(connection: Connection, connectionLock: string)

المعلمات

connection

Connection

اتصال AMQP.

connectionLock

string

سلسلة فريدة (عادة guid) لكل اتصال.

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

cbsLock

اسم التأمين الفريد لكل جلسة $cbs لكل اتصال يتم استخدامه للحصول على التأمين لإنشاء جلسة عمل cbs إذا لم يكن أحدها موجودا لاتصال amqp.

cbsLock: string

قيمة الخاصية

string

connection

اتصال AMQP.

connection: Connection

قيمة الخاصية

Connection

connectionLock

اسم التأمين الفريد لكل اتصال يستخدم للحصول على التأمين لإنشاء اتصال amqp إذا لم يكن موجودا.

connectionLock: string

قيمة الخاصية

string

endpoint

نقطة نهاية CBS - "$cbs"

endpoint: string

قيمة الخاصية

string

replyTo

CBS replyTo - اسم ارتباط المتلقي الذي يجب أن ترد عليه الخدمة.

replyTo: string

قيمة الخاصية

string

تفاصيل الأسلوب

close()

إغلاق جلسة عمل AMQP cbs إلى EventHub/ServiceBus لهذا العميل، مع إرجاع وعد سيتم حله عند اكتمال قطع الاتصال.

function close(): Promise<void>

المرتجعات

Promise<void>

init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

إنشاء مثيل أحادي لجلسة عمل CBS إذا لم تتم تهيئته مسبقا على الاتصال المحدد.

function init(options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<void>

المعلمات

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

المعلمات الاختيارية التي يمكن استخدامها للتأثير على سلوك هذا الأسلوب. على سبيل المثال، يمكن تمرير abortSignal للسماح بإلغاء استدعاء init قيد التقدم.

المرتجعات

Promise<void>

الوعد<باطل.>

isOpen()

يشير إلى ما إذا كان ارتباط مستقبل مرسل cbs مفتوحا أو مغلقا.

function isOpen(): boolean

المرتجعات

boolean

true مفتوحة، false مغلقة.

negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

التفاوض على مطالبة CBS مع خدمة EventHub/ServiceBus.

function negotiateClaim(audience: string, token: string, tokenType: TokenType, options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<CbsResponse>

المعلمات

audience

string

جمهور رمز الكيان الذي يتم طلب الرمز المميز له في أحد النماذج التالية:

• ServiceBus

  • مرسل

    • "sb://<yournamespace>.servicebus.windows.net/<queue-name>"
    • "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

  • "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

  • إدارة العميل - "sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management". - "sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management".

• eventHubs

  • مرسل

    • "sb://<yournamespace>.servicebus.windows.net/<hubName>"
    • Person.

  • جهاز استقبال

    • Person.

  • ManagementClient

    • Person.

token

string

الرمز المميز الذي يحتاج إلى إرساله في طلب وضع الرمز المميز.

tokenType

TokenType

نوع الرمز المميز المستخدم. على سبيل المثال، "jwt" أو "servicebus.windows.net:sastoken".

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

المعلمات الاختيارية التي يمكن استخدامها للتأثير على سلوك هذا الأسلوب. على سبيل المثال، يمكن تمرير abortSignal للسماح بإلغاء استدعاء negotiateClaim قيد التقدم.

المرتجعات

Promise<CbsResponse>

وعد يحل عند نجاح مصادقة $cbs ويرفض عند حدوث خطأ أثناء مصادقة $cbs.

remove()

يزيل جلسة عمل AMQP cbs إلى EventHub/ServiceBus لهذا العميل،

function remove()