@azure/event-hubs package
الفصول
EventHubBufferedProducerClient |
اعتمادا على الخيارات المحددة عند إدراج الأحداث في قائمة الانتظار، قد يتم تعيينها تلقائيا إلى قسم، أو تجميعها وفقا لمفتاح القسم المحدد، أو تعيين قسم مطلوب خصيصا. يهدف هذا النموذج إلى تحويل عبء إدارة الدفعات من المتصلين، على حساب التوقيت غير المحدد، لموعد نشر الأحداث. هناك مفاضلات إضافية يجب مراعاتها، أيضا:
في السيناريوهات التي يكون من المهم فيها نشر الأحداث على الفور بنتيجة حتمية، تأكد من تعيين مفاتيح الأقسام إلى قسم متناسق مع الناشرين الآخرين، أو حيث يكون تكبير التوفر مطلبا، يوصى باستخدام |
EventHubConsumerClient |
هناك طرق متعددة لإنشاء
اختياريا، يمكنك أيضا تمرير:
|
EventHubProducerClient |
هناك طرق متعددة لإنشاء
اختياريا، يمكنك أيضا تمرير حقيبة خيارات لتكوين نهج إعادة المحاولة أو إعدادات الوكيل. |
MessagingError |
يصف الفئة الأساسية لخطأ المراسلة. |
الواجهات
BufferedCloseOptions |
خيارات لتكوين الأسلوب على |
BufferedFlushOptions |
خيارات لتكوين الأسلوب على |
Checkpoint |
تهدف نقطة التحقق إلى تمثيل آخر حدث تمت معالجته بنجاح بواسطة المستخدم من قسم معين من مجموعة مستهلكين في مثيل Event Hub.
لا يتوقع من المستخدمين التفاعل معهم |
CheckpointStore |
تخزن نقطة التحقق معلومات ملكية القسم وتفاصيل نقطة التحقق وتستردها لكل قسم في مجموعة مستهلكين معينة لمثيل مركز الأحداث. لا يقصد من المستخدمين تنفيذ يمكن العثور على عمليات |
CreateBatchOptions |
خيارات لتكوين الأسلوب على
استخدام المثال:
|
EnqueueEventOptions |
خيارات لتكوين الأسلوب على |
EventData |
الواجهة التي تصف البيانات التي سيتم إرسالها إلى Event Hub.
استخدم هذا كمرجع عند إنشاء الكائن المراد إرساله عند استخدام
|
EventDataAdapterParameters |
معلمات للدالة |
EventDataBatch |
واجهة تمثل دفعة من الأحداث التي يمكن استخدامها لإرسال الأحداث إلى Event Hub. لإنشاء الدفعة، استخدم الأسلوب على |
EventHubBufferedProducerClientOptions |
يصف الخيارات التي يمكن توفيرها أثناء إنشاء |
EventHubClientOptions |
يصف الخيارات التي يمكن توفيرها أثناء إنشاء EventHubClient.
يمكن أن يكون استخدام المثال:
|
EventHubConnectionStringProperties |
مجموعة الخصائص التي تتضمن مركز الأحداث سلسلة الاتصال. |
EventHubConsumerClientOptions |
يصف الخيارات التي يمكن توفيرها أثناء إنشاء EventHubConsumerClient.
يمكن أن يكون استخدام المثال:
|
EventHubProperties |
يصف معلومات وقت التشغيل لمركز الأحداث. |
EventPosition |
يمثل موضع حدث في قسم Event Hub، يستخدم عادة عند استدعاء للحصول على EventPosition يمثل بداية الدفق أو نهايته، استخدم الثوابت |
GetEventHubPropertiesOptions |
مجموعة الخيارات لتكوين سلوك
|
GetPartitionIdsOptions |
مجموعة الخيارات لتكوين سلوك
|
GetPartitionPropertiesOptions |
مجموعة الخيارات لتكوين سلوك
|
LastEnqueuedEventProperties |
مجموعة من المعلومات حول آخر حدث مدرج في قائمة الانتظار لقسم، كما لاحظ المستهلك أثناء تلقي الأحداث من خدمة مراكز الأحداث |
LoadBalancingOptions |
حقيبة خيارات لتكوين إعدادات موازنة التحميل. |
OnSendEventsErrorContext |
يحتوي على الأحداث التي لم يتم إرسالها بنجاح إلى Event Hub والقسم الذي تم تعيينه إليه والخطأ الذي تمت مواجهته أثناء الإرسال. |
OnSendEventsSuccessContext |
يحتوي على الأحداث التي تم إرسالها بنجاح إلى Event Hub، والقسم الذي تم تعيينه إليه. |
OperationOptions |
خيارات لتكوين التتبع و abortSignal. |
PartitionContext |
الواجهة التي تصف السياق الذي تم تمريره إلى كل من الدالات التي تعد جزءا من |
PartitionOwnership |
واجهة تمثل التفاصيل الخاصة بمثيل
ملاحظة: يتم استخدام هذا داخليا من قبل |
PartitionProperties |
يصف معلومات وقت التشغيل لقسم EventHub. |
ReceivedEventData |
الواجهة التي تصف بنية الحدث المستلمة من Event Hub.
استخدم هذا كمرجع عند إنشاء الدالة |
RetryOptions |
خيارات نهج إعادة المحاولة التي تحدد الوضع وعدد مرات إعادة المحاولة والفاصل الزمني لإعادة المحاولة وما إلى ذلك. |
SendBatchOptions |
خيارات لتكوين
|
SubscribeOptions |
خيارات لتكوين الأسلوب على |
Subscription |
الواجهة التي تصف الكائن الذي تم إرجاعه بواسطة |
SubscriptionEventHandlers |
الواجهة التي تصف الوظائف التي سينفذها المستخدم والتي يتم استدعاؤها بواسطة |
TokenCredential |
يمثل بيانات اعتماد قادرة على توفير رمز مميز للمصادقة. |
TryAddOptions |
خيارات لتكوين سلوك الأسلوب على |
WebSocketImpl |
يصف الشكل المطلوب لمنشئات WebSocket. |
WebSocketOptions |
خيارات لتكوين قناة اتصال AMQP عبر مآخذ ويب. |
النوع أسماء مستعارة
ProcessCloseHandler |
قام توقيع المستخدم بتوفير الدالة التي تم استدعاؤها بعد |
ProcessErrorHandler |
قام توقيع المستخدم بتوفير الدالة التي تم استدعاؤها بواسطة |
ProcessEventsHandler |
توقيع الدالة المقدمة من المستخدم التي تم استدعاؤها بواسطة |
ProcessInitializeHandler |
قام توقيع المستخدم بتوفير الدالة التي تم استدعاؤها قبل |
التعدادات
CloseReason |
قائمة تعداد تمثل الأسباب المختلفة لإيقاف |
RetryMode |
يصف نوع وضع إعادة المحاولة |
الوظائف
create |
دالة تنشئ محول بيانات الحدث. يمكن استخدام هذا المحول مع |
parse |
التحليلات المعطاة سلسلة الاتصال في الخصائص المختلفة المطبقة على Azure Event Hubs. الخصائص مفيدة لإنشاء EventHubProducerClient أو EventHubConsumerClient. |
تفاصيل الوظيفة
createEventDataAdapter(EventDataAdapterParameters)
دالة تنشئ محول بيانات الحدث. يمكن استخدام هذا المحول مع @azure/schema-registry-avro
لترميز النص الأساسي وفك ترميزه في بيانات الحدث.
function createEventDataAdapter(params?: EventDataAdapterParameters): MessageAdapter<EventData>
المعلمات
- params
- EventDataAdapterParameters
معلمات لإنشاء بيانات الحدث
المرتجعات
MessageAdapter<EventData>
محول بيانات الحدث الذي يمكنه إنتاج بيانات الحدث واستهلاكها
parseEventHubConnectionString(string)
التحليلات المعطاة سلسلة الاتصال في الخصائص المختلفة المطبقة على Azure Event Hubs. الخصائص مفيدة لإنشاء EventHubProducerClient أو EventHubConsumerClient.
function parseEventHubConnectionString(connectionString: string): Readonly<EventHubConnectionStringProperties>
المعلمات
- connectionString
-
string
سلسلة الاتصال المقترن بنهج الوصول المشترك الذي تم إنشاؤه لمساحة اسم مراكز الأحداث.
المرتجعات
Readonly<EventHubConnectionStringProperties>