EventHubConsumerClient class

الحزمة:

@azure/event-hubs

EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub.

هناك طرق متعددة لإنشاء EventHubConsumerClient

• استخدم سلسلة الاتصال من نهج SAS الذي تم إنشاؤه لمثيل Event Hub الخاص بك.
• استخدم سلسلة الاتصال من نهج SAS الذي تم إنشاؤه لمساحة اسم Event Hub واسم مثيل Event Hub
• استخدم مساحة الاسم الكاملة مثل <yournamespace>.servicebus.windows.net، وعنصر بيانات الاعتماد.

اختياريا، يمكنك أيضا تمرير:

• حقيبة خيارات لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.
• مخزن نقاط التحقق الذي يستخدمه العميل لقراءة نقاط التحقق لتحديد الموضع الذي يجب أن يستأنف منه تلقي الأحداث عند إعادة تشغيل التطبيق الخاص بك. يستخدم العميل أيضا مخزن نقاط التحقق لتحميل مثيلات متعددة من التطبيق الخاص بك.

المنشئون

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)	EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)	EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)	EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)	EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)	EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)	EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.

الخصائص

defaultConsumerGroupName	اسم مجموعة المستهلكين الافتراضية في خدمة مراكز الأحداث.
eventHubName	اسم مثيل Event Hub الذي تم إنشاء هذا العميل له.
fullyQualifiedNamespace	مساحة الاسم المؤهلة بالكامل لمثيل Event Hub الذي تم إنشاء هذا العميل له. من المحتمل أن يكون هذا مشابها ل .servicebus.windows.net.
identifier	الاسم المستخدم لتعريف EventHubConsumerClient هذا. إذا لم يتم تحديده أو إفراغه، فسيتم إنشاء واحد فريد عشوائي.

الأساليب

close()	إغلاق اتصال AMQP بمثيل Event Hub، مع إرجاع وعد سيتم حله عند اكتمال قطع الاتصال.
getEventHubProperties(GetEventHubPropertiesOptions)	يوفر معلومات وقت تشغيل Event Hub.
getPartitionIds(GetPartitionIdsOptions)	يوفر المعرف لكل قسم مقترن بمركز الأحداث.
getPartitionProperties(string, GetPartitionPropertiesOptions)	يوفر معلومات حول حالة القسم المحدد.
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)	اشترك في الأحداث من قسم واحد. اتصل ب close() على الكائن الذي تم إرجاعه لإيقاف تلقي الأحداث. استخدام المثال: const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName); const subscription = client.subscribe( partitionId, { processEvents: (events, context) => { console.log("Received event count: ", events.length) }, processError: (err, context) => { console.log("Error: ", err) } }, { startPosition: earliestEventPosition } );
subscribe(SubscriptionEventHandlers, SubscribeOptions)	اشترك في الأحداث من جميع الأقسام. إذا تم توفير مخزن نقاط التحقق إلى EventHubConsumerClient وكان هناك مثيلات متعددة للتطبيق الخاص بك، فسيشترك كل مثيل في مجموعة فرعية من الأقسام بحيث يكون الحمل متوازنا بينها. اتصل ب close() على الكائن الذي تم إرجاعه لإيقاف تلقي الأحداث. استخدام المثال: const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName); const subscription = client.subscribe( { processEvents: (events, context) => { console.log("Received event count: ", events.length) }, processError: (err, context) => { console.log("Error: ", err) } }, { startPosition: earliestEventPosition } );

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

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

المعلمات

consumerGroup

string

اسم مجموعة المستهلكين التي تريد معالجة الأحداث منها.

connectionString

string

سلسلة الاتصال المراد استخدامها للاتصال بمثيل Event Hub. من المتوقع أن يتم تضمين خصائص المفتاح المشترك ومسار Event Hub في سلسلة الاتصال هذه. على سبيل المثال'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

checkpointStore

CheckpointStore

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

options

EventHubConsumerClientOptions

مجموعة من الخيارات التي يجب تطبيقها عند تكوين العميل.

• retryOptions : تكوين نهج إعادة المحاولة لجميع العمليات على العميل. على سبيل المثال، { "maxRetries": 4 } أو { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: تكوين قناة اتصال AMQP عبر مآخذ ويب.
• userAgent : سلسلة لإلحاقها بسلسلة عامل المستخدم المضمنة التي يتم تمريرها إلى الخدمة.

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)

المعلمات

consumerGroup

string

اسم مجموعة المستهلكين التي تريد معالجة الأحداث منها.

connectionString

string

سلسلة الاتصال المراد استخدامها للاتصال بمثيل Event Hub. من المتوقع أن يتم تضمين خصائص المفتاح المشترك ومسار Event Hub في سلسلة الاتصال هذه. على سبيل المثال'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

options

EventHubConsumerClientOptions

مجموعة من الخيارات التي يجب تطبيقها عند تكوين العميل.

• retryOptions : تكوين نهج إعادة المحاولة لجميع العمليات على العميل. على سبيل المثال، { "maxRetries": 4 } أو { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: تكوين قناة اتصال AMQP عبر مآخذ ويب.
• userAgent : سلسلة لإلحاقها بسلسلة عامل المستخدم المضمنة التي يتم تمريرها إلى الخدمة.

EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

المعلمات

consumerGroup

string

اسم مجموعة المستهلكين التي تريد معالجة الأحداث منها.

connectionString

string

سلسلة الاتصال المراد استخدامها للاتصال بمساحة اسم مراكز الأحداث. من المتوقع أن يتم تضمين خصائص المفتاح المشترك في سلسلة الاتصال هذه، ولكن ليس مسار Event Hub، مثل 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

اسم Event Hub المحدد لتوصيل العميل به.

checkpointStore

CheckpointStore

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

options

EventHubConsumerClientOptions

مجموعة من الخيارات التي يجب تطبيقها عند تكوين العميل.

• retryOptions : تكوين نهج إعادة المحاولة لجميع العمليات على العميل. على سبيل المثال، { "maxRetries": 4 } أو { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: تكوين قناة اتصال AMQP عبر مآخذ ويب.
• userAgent : سلسلة لإلحاقها بسلسلة عامل المستخدم المضمنة التي يتم تمريرها إلى الخدمة.

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)

المعلمات

consumerGroup

string

اسم مجموعة المستهلكين التي تريد معالجة الأحداث منها.

connectionString

string

سلسلة الاتصال المراد استخدامها للاتصال بمساحة اسم مراكز الأحداث. من المتوقع أن يتم تضمين خصائص المفتاح المشترك في سلسلة الاتصال هذه، ولكن ليس مسار Event Hub، مثل 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

اسم Event Hub المحدد لتوصيل العميل به.

options

EventHubConsumerClientOptions

مجموعة من الخيارات التي يجب تطبيقها عند تكوين العميل.

• retryOptions : تكوين نهج إعادة المحاولة لجميع العمليات على العميل. على سبيل المثال، { "maxRetries": 4 } أو { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: تكوين قناة اتصال AMQP عبر مآخذ ويب.
• userAgent : سلسلة لإلحاقها بسلسلة عامل المستخدم المضمنة التي يتم تمريرها إلى الخدمة.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.

new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

المعلمات

consumerGroup

string

اسم مجموعة المستهلكين التي تريد معالجة الأحداث منها.

fullyQualifiedNamespace

string

مساحة الاسم الكاملة التي من المحتمل أن تكون مشابهة ل .servicebus.windows.net

eventHubName

string

اسم Event Hub المحدد لتوصيل العميل به.

credential

TokenCredential | NamedKeyCredential | SASCredential

عنصر بيانات اعتماد يستخدمه العميل للحصول على الرمز المميز لمصادقة الاتصال بخدمة Azure Event Hubs. راجع @azure/الهوية لإنشاء بيانات الاعتماد التي تدعم مصادقة AAD. AzureNamedKeyCredential استخدم من @azure/core-auth إذا كنت تريد تمرير SharedAccessKeyName و SharedAccessKey دون استخدام سلسلة اتصال. تعين هذه الحقول إلى name الحقلين و key على التوالي في AzureNamedKeyCredential. AzureSASCredential استخدم من @azure/core-auth إذا كنت تريد تمرير SharedAccessSignature دون استخدام سلسلة اتصال. يتم تعيين هذا الحقل إلى signature في AzureSASCredential.

checkpointStore

CheckpointStore

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

options

EventHubConsumerClientOptions

مجموعة من الخيارات التي يجب تطبيقها عند تكوين العميل.

• retryOptions : تكوين نهج إعادة المحاولة لجميع العمليات على العميل. على سبيل المثال، { "maxRetries": 4 } أو { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: تكوين قناة اتصال AMQP عبر مآخذ ويب.
• userAgent : سلسلة لإلحاقها بسلسلة عامل المستخدم المضمنة التي يتم تمريرها إلى الخدمة.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

EventHubConsumerClient يتم استخدام الفئة لاستهلاك الأحداث من Event Hub. options استخدم parmeter لتكوين نهج إعادة المحاولة أو إعدادات الوكيل.

new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)

المعلمات

consumerGroup

string

اسم مجموعة المستهلكين التي تريد معالجة الأحداث منها.

fullyQualifiedNamespace

string

مساحة الاسم الكاملة التي من المحتمل أن تكون مشابهة ل .servicebus.windows.net

eventHubName

string

اسم Event Hub المحدد لتوصيل العميل به.

credential

TokenCredential | NamedKeyCredential | SASCredential

عنصر بيانات اعتماد يستخدمه العميل للحصول على الرمز المميز لمصادقة الاتصال بخدمة Azure Event Hubs. راجع @azure/الهوية لإنشاء بيانات الاعتماد التي تدعم مصادقة AAD. AzureNamedKeyCredential استخدم من @azure/core-auth إذا كنت تريد تمرير SharedAccessKeyName و SharedAccessKey دون استخدام سلسلة اتصال. تعين هذه الحقول إلى name الحقلين و key على التوالي في AzureNamedKeyCredential. AzureSASCredential استخدم من @azure/core-auth إذا كنت تريد تمرير SharedAccessSignature دون استخدام سلسلة اتصال. يتم تعيين هذا الحقل إلى signature في AzureSASCredential.

options

EventHubConsumerClientOptions

مجموعة من الخيارات التي يجب تطبيقها عند تكوين العميل.

• retryOptions : تكوين نهج إعادة المحاولة لجميع العمليات على العميل. على سبيل المثال، { "maxRetries": 4 } أو { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: تكوين قناة اتصال AMQP عبر مآخذ ويب.
• userAgent : سلسلة لإلحاقها بسلسلة عامل المستخدم المضمنة التي يتم تمريرها إلى الخدمة.

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

defaultConsumerGroupName

اسم مجموعة المستهلكين الافتراضية في خدمة مراكز الأحداث.

static defaultConsumerGroupName: string

قيمة الخاصية

string

eventHubName

اسم مثيل Event Hub الذي تم إنشاء هذا العميل له.

string eventHubName

قيمة الخاصية

string

fullyQualifiedNamespace

مساحة الاسم المؤهلة بالكامل لمثيل Event Hub الذي تم إنشاء هذا العميل له. من المحتمل أن يكون هذا مشابها ل .servicebus.windows.net.

string fullyQualifiedNamespace

قيمة الخاصية

string

identifier

الاسم المستخدم لتعريف EventHubConsumerClient هذا. إذا لم يتم تحديده أو إفراغه، فسيتم إنشاء واحد فريد عشوائي.

identifier: string

قيمة الخاصية

string

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

close()

إغلاق اتصال AMQP بمثيل Event Hub، مع إرجاع وعد سيتم حله عند اكتمال قطع الاتصال.

function close(): Promise<void>

المرتجعات

Promise<void>

وعد

getEventHubProperties(GetEventHubPropertiesOptions)

يوفر معلومات وقت تشغيل Event Hub.

function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>

المعلمات

options

GetEventHubPropertiesOptions

مجموعة الخيارات التي يجب تطبيقها على استدعاء العملية.

المرتجعات

Promise<EventHubProperties>

وعد يحل بمعلومات حول مثيل Event Hub.

getPartitionIds(GetPartitionIdsOptions)

يوفر المعرف لكل قسم مقترن بمركز الأحداث.

function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>

المعلمات

options

GetPartitionIdsOptions

مجموعة الخيارات التي يجب تطبيقها على استدعاء العملية.

المرتجعات

Promise<string[]>

وعد يحل مع صفيف من السلاسل التي تمثل المعرف لكل قسم مقترن بمركز الأحداث.

getPartitionProperties(string, GetPartitionPropertiesOptions)

يوفر معلومات حول حالة القسم المحدد.

function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>

المعلمات

partitionId

string

معرف القسم المطلوب معلومات له.

options

GetPartitionPropertiesOptions

مجموعة الخيارات التي يجب تطبيقها على استدعاء العملية.

المرتجعات

Promise<PartitionProperties>

وعد يحل بمعلومات حول حالة القسم .

subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

اشترك في الأحداث من قسم واحد. اتصل ب close() على الكائن الذي تم إرجاعه لإيقاف تلقي الأحداث.

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

const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
 partitionId,
 {
   processEvents: (events, context) => { console.log("Received event count: ", events.length) },
   processError: (err, context) => { console.log("Error: ", err) }
 },
 { startPosition: earliestEventPosition }
);

function subscribe(partitionId: string, handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription

المعلمات

partitionId

string

معرف القسم للاشتراك فيه.

handlers

SubscriptionEventHandlers

معالجات دورة حياة الاشتراك - تهيئة الاشتراك للقسم، وتلقي الأحداث، ومعالجة الأخطاء وإغلاق اشتراك في القسم.

options

SubscribeOptions

تكوين الطريقة التي يتم بها تلقي الأحداث. الأكثر شيوعا هي maxBatchSize والتي maxWaitTimeInSeconds تتحكم في تدفق الأحداث إلى المعالج المقدم لتلقي الأحداث بالإضافة إلى موضع البدء. على سبيل المثال،⁧{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }⁩

المرتجعات

Subscription

subscribe(SubscriptionEventHandlers, SubscribeOptions)

اشترك في الأحداث من جميع الأقسام.

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

اتصل ب close() على الكائن الذي تم إرجاعه لإيقاف تلقي الأحداث.

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

const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
 {
   processEvents: (events, context) => { console.log("Received event count: ", events.length) },
   processError: (err, context) => { console.log("Error: ", err) }
 },
 { startPosition: earliestEventPosition }
);

function subscribe(handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription

المعلمات

handlers

SubscriptionEventHandlers

معالجات دورة حياة الاشتراك - تهيئة الاشتراك لكل قسم، وتلقي الأحداث، ومعالجة الأخطاء وإغلاق الاشتراك لكل قسم.

options

SubscribeOptions

تكوين الطريقة التي يتم بها تلقي الأحداث. الأكثر شيوعا هي maxBatchSize والتي maxWaitTimeInSeconds تتحكم في تدفق الأحداث إلى المعالج المقدم لتلقي الأحداث بالإضافة إلى موضع البدء. على سبيل المثال،⁧{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }⁩

المرتجعات

Subscription