DeviceClientOptions interface

الحزمة:

azure-iot-device

خيارات لكائن العميل. تم تمريرها إلى الدالة setOptions .

مثال

 var options = {
   cert: myX509Certificate,
   key: myX509Key,
   http: {
     receivePolicy: {
       interval: 10
     }
   }
 }
 client.setOptions(options, callback);

Extends

X509

الخصائص

amqp	عنصر اختياري مع خيارات خاصة بنقل AMQP
ca	الشهادة العامة في نموذج PEM للمرجع المصدق الذي تستخدمه خدمة Hub. هذا هو المرجع المصدق الذي يستخدمه المركز لتأمين اتصالات TLS ويتحقق العميل من صحة الاتصال باستخدام هذا الشهادة العامة من أجل التحقق من صحة هوية المركز. إذا كنت تتصل ب Azure IoT Hub داخل مركز بيانات Azure، فلن تحتاج إلى تعيين هذا. إذا كنت تتصل ببعض لوحة الوصل الأخرى (مثل Edge Hub)، فقد تحتاج إلى تعيين هذا إلى شهادة الخادم التي يستخدمها المركز ل TLS.
http	عنصر اختياري مع خيارات خاصة بنقل HTTP
keepalive	الفاصل الزمني المحتفظ به بتنسيق رقمي (بالثوان). يتحكم هذا في اختبار الاتصال الحافظ ل MQTT على وجه التحديد. إذا كنت تستخدم AMQP أو HTTP، فلن يفعل ذلك شيئا.
modelId	!! Digital Twin Use Only!! السلسلة المستخدمة في اسم مستخدم MQTT الذي يقوم بتعيين Digital Twin modelId.
mqtt	عنصر اختياري مع خيارات خاصة بنقل MQTT
productInfo	معلومات مخصصة معرفة من قبل المستخدم ليتم إلحاقها بمعلومات عامل المستخدم الموجودة. تستخدم Microsoft معلومات تعريف عامل المستخدم في الغالب داخليا لتحديد بيانات التعريف المتعلقة باستخدام عميل الجهاز ل Azure IoT.
tokenRenewal	عنصر اختياري بقيم تجديد الرمز المميز. استخدم فقط مع المصادقة التي تستخدم مفاتيح مشتركة مسبقا.

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

cert	شهادة X509.
clientCertEngine	اسم محرك OpenSSL الذي يمكن أن يوفر شهادة العميل.
key	المفتاح المقترن بشهادة X509.
passphrase	عبارة المرور المستخدمة لفك تشفير المفتاح المقترن بشهادة X509.

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

amqp

عنصر اختياري مع خيارات خاصة بنقل AMQP

amqp?: AmqpTransportOptions

قيمة الخاصية

AmqpTransportOptions

ca

الشهادة العامة في نموذج PEM للمرجع المصدق الذي تستخدمه خدمة Hub. هذا هو المرجع المصدق الذي يستخدمه المركز لتأمين اتصالات TLS ويتحقق العميل من صحة الاتصال باستخدام هذا الشهادة العامة من أجل التحقق من صحة هوية المركز. إذا كنت تتصل ب Azure IoT Hub داخل مركز بيانات Azure، فلن تحتاج إلى تعيين هذا. إذا كنت تتصل ببعض لوحة الوصل الأخرى (مثل Edge Hub)، فقد تحتاج إلى تعيين هذا إلى شهادة الخادم التي يستخدمها المركز ل TLS.

ca?: string

قيمة الخاصية

string

http

عنصر اختياري مع خيارات خاصة بنقل HTTP

http?: HttpTransportOptions

قيمة الخاصية

HttpTransportOptions

keepalive

الفاصل الزمني المحتفظ به بتنسيق رقمي (بالثوان). يتحكم هذا في اختبار الاتصال الحافظ ل MQTT على وجه التحديد. إذا كنت تستخدم AMQP أو HTTP، فلن يفعل ذلك شيئا.

keepalive?: number

قيمة الخاصية

number

modelId

!! Digital Twin Use Only!! السلسلة المستخدمة في اسم مستخدم MQTT الذي يقوم بتعيين Digital Twin modelId.

modelId?: string

قيمة الخاصية

string

mqtt

عنصر اختياري مع خيارات خاصة بنقل MQTT

mqtt?: MqttTransportOptions

قيمة الخاصية

MqttTransportOptions

productInfo

معلومات مخصصة معرفة من قبل المستخدم ليتم إلحاقها بمعلومات عامل المستخدم الموجودة. تستخدم Microsoft معلومات تعريف عامل المستخدم في الغالب داخليا لتحديد بيانات التعريف المتعلقة باستخدام عميل الجهاز ل Azure IoT.

productInfo?: string

قيمة الخاصية

string

tokenRenewal

عنصر اختياري بقيم تجديد الرمز المميز. استخدم فقط مع المصادقة التي تستخدم مفاتيح مشتركة مسبقا.

tokenRenewal?: TokenRenewalValues

قيمة الخاصية

TokenRenewalValues

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

cert

شهادة X509.

cert?: string | Buffer | string[] | Buffer[]

قيمة الخاصية

string | Buffer | string[] | Buffer[]

موروث من X509.cert

clientCertEngine

اسم محرك OpenSSL الذي يمكن أن يوفر شهادة العميل.

clientCertEngine?: string

قيمة الخاصية

string

موروث من X509.clientCertEngine

key

المفتاح المقترن بشهادة X509.

key?: string | Buffer

قيمة الخاصية

string | Buffer

موروث من X509.key

passphrase

عبارة المرور المستخدمة لفك تشفير المفتاح المقترن بشهادة X509.

passphrase?: string

قيمة الخاصية

string

موروث من عبارة X509.pass