EventHubConsumerClientOptions interface

الحزمة:

@azure/event-hubs

يصف الخيارات التي يمكن توفيرها أثناء إنشاء EventHubConsumerClient.

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

يمكن أن يكون { "maxRetries": 4 }الاستخدام البسيط هو .

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

{
    retryOptions: {
        maxRetries: 4
    }
}

Extends

EventHubClientOptions

الخصائص

loadBalancingOptions

خيارات لضبط كيفية أقسام مطالبات EventHubConsumerClient.

الخصائص الموروثة

customEndpointAddress	نقطة نهاية مخصصة لاستخدامها عند الاتصال بخدمة مراكز الأحداث. يمكن أن يكون هذا مفيدا عندما لا تسمح شبكتك بالاتصال بعنوان نقطة نهاية Azure Event Hubs القياسي، ولكنها تسمح بالاتصال من خلال وسيط. مثال: "https://my.custom.endpoint:100/"؛
identifier	اسم فريد يستخدم لتعريف العميل. إذا لم يتم توفيره، فسيتم استخدام GUID كمعرف
retryOptions	خيارات لتكوين نهج إعادة المحاولة لجميع العمليات على العميل. على سبيل المثال، { "maxRetries": 4 } أو { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent	القيمة التي يتم إلحاقها بسلسلة عامل المستخدم المضمنة التي يتم تمريرها إلى خدمة مراكز الأحداث.
webSocketOptions	خيارات لتكوين قناة اتصال AMQP عبر مآخذ ويب.

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

loadBalancingOptions

خيارات لضبط كيفية أقسام مطالبات EventHubConsumerClient.

loadBalancingOptions?: LoadBalancingOptions

قيمة الخاصية

LoadBalancingOptions

تفاصيل الخاصية الموروثة

customEndpointAddress

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

مثال: "https://my.custom.endpoint:100/"؛

customEndpointAddress?: string

قيمة الخاصية

string

موروث منEventHubClientOptions.customEndpointAddress

identifier

اسم فريد يستخدم لتعريف العميل. إذا لم يتم توفيره، فسيتم استخدام GUID كمعرف

identifier?: string

قيمة الخاصية

string

موروث منEventHubClientOptions.identifier

retryOptions

خيارات لتكوين نهج إعادة المحاولة لجميع العمليات على العميل. على سبيل المثال، { "maxRetries": 4 } أو { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

قيمة الخاصية

RetryOptions

موروث منEventHubClientOptions.retryOptions

userAgent

القيمة التي يتم إلحاقها بسلسلة عامل المستخدم المضمنة التي يتم تمريرها إلى خدمة مراكز الأحداث.

userAgent?: string

قيمة الخاصية

string

موروث منEventHubClientOptions.userAgent

webSocketOptions

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

webSocketOptions?: WebSocketOptions

قيمة الخاصية

WebSocketOptions

موروث منEventHubClientOptions.webSocketOptions