azure-iot-common package

الفصول

Message	Message يتم استخدام الكائن لبيانات تتبع الاستخدام (من جهاز إلى سحابة) والأوامر (من السحابة إلى الجهاز) المراسلة غير المتزامنة بين الجهاز وخدمة IoT Hub. إنه غير محدد للنقل، ما يعني أنه يعمل بنفس الطريقة عبر AMQP وMQTT وHTTP.
ArgumentError	حدث خطأ عندما تكون الوسيطة غير صالحة.
ArgumentOutOfRangeError	يتم طرح الخطأ عندما تحتوي الوسيطة على قيمة خارج نطاق admissible.
BadDeviceResponseError	حدث خطأ عندما يرسل جهاز استجابة سيئة لاستدعاء أسلوب الجهاز.
CloudToDeviceDetachedError	حدث خطأ عندما توقفت ميزة c2d عن العمل على مستوى النقل، مما يتطلب من العميل إعادة محاولة بدء تشغيله.
DeviceAlreadyExistsError	حدث خطأ عندما يكون معرف الجهاز المستخدم لإنشاء الجهاز موجودا بالفعل في سجل هوية الجهاز.
DeviceMaximumQueueDepthExceededError	حدث خطأ عندما تكون قائمة انتظار الرسائل لجهاز ممتلئة.
DeviceMessageLockLostError	حدث خطأ عند فشل تسوية رسالة بسبب فقدان رمز التأمين المقترن بالرسالة.
DeviceMethodsDetachedError	حدث خطأ عندما توقفت ميزة أساليب الجهاز عن العمل على مستوى النقل، مما يتطلب من العميل إعادة محاولة بدء تشغيله.
DeviceNotFoundError	حدث خطأ عندما يتعذر العثور على جهاز في سجل مثيل IoT Hub.
DeviceRegistrationFailedError	حدث خطأ عند فشل عملية تسجيل DPS
DeviceTimeoutError	حدث خطأ عندما لا يعالج الجهاز استدعاء الأسلوب في الوقت المناسب.
FormatError	حدث خطأ عندما لا يتم تنسيق سلسلة من المفترض أن تحتوي على تنسيق معين بشكل صحيح.
GatewayTimeoutError	حدث خطأ عندما لا يعالج مثيل IoT Hub استدعاء أسلوب الجهاز في الوقت المناسب.
InternalServerError	حدث خطأ عند حدوث خطأ خادم داخلي. ربما وجدت خطأ؟
InvalidEtagError	حدث خطأ عندما يكون eTag المحدد منسقا بشكل غير صحيح أو قديما.
InvalidOperationError	حدث خطأ عند محاولة إجراء عملية ولكن غير مسموح به.
IotHubNotFoundError	حدث خطأ عندما لم يتم العثور على مركز Azure IoT.
IotHubQuotaExceededError	حدث خطأ أثناء تجاوز الحصة النسبية لمركز Azure IoT. تتم إعادة تعيين الحصص بشكل دوري، وسيتعين على هذه العملية الانتظار حتى ذلك الحين. لمعرفة المزيد حول الحصص النسبية، راجع حصص Azure IoT Hub النسبية والتقييد
IoTHubSuspendedError	حدث خطأ عند إيقاف IoT Hub مؤقتا.
JobNotFoundError	حدث خطأ عندما لم يتم العثور على المهمة ذات المعرف المحدد.
MessageTooLargeError	حدث خطأ عندما تكون الرسالة المرسلة كبيرة جدا: الحد الأقصى للحجم هو 256 كيلوبايت.
NotConnectedError	حدث خطأ عند قطع اتصال الجهاز ولا يمكن إكمال العملية.
NotImplementedError	حدث خطأ عندما لا يتم تنفيذ ميزة بعد ولكن العنصر النائب موجود.
OperationCancelledError	حدث خطأ عند إلغاء أي عملية (محلية أو بعيدة)
PreconditionFailedError	حدث خطأ عندما لم يتم استيفاء شرط كان من المفترض أن يتم تنفيذه لتنفيذ عملية.
SecurityDeviceError	حدث خطأ عند فشل جهاز/برنامج تشغيل أمان منخفض المستوى.
ServiceUnavailableError	حدث خطأ عندما تكون الخدمة غير متوفرة. يجب إعادة محاولة العملية.
ThrottlingError	حدث خطأ عند تقييد IoT Hub بسبب النشاط المفرط. لمعرفة المزيد حول الحصص النسبية، راجع حصص Azure IoT Hub النسبية والتقييد
TimeoutError	حدث خطأ عند حدوث مهلة
TooManyDevicesError	حدث خطأ عند الوصول إلى الحد الأقصى لعدد الأجهزة على مركز معين.
TwinDetachedError	حدث خطأ عندما توقفت الميزة المزدوجة عن العمل على مستوى النقل، مما يتطلب من العميل إعادة محاولة بدء تشغيله.
TwinRequestError	ظهور خطأ عام عند فشل طلب مزدوج برمز خطأ غير معروف.
UnauthorizedError	حدث خطأ عندما تكون معلمات الاتصال خاطئة ورفض الخادم الاتصال.
Connected	يتم إرجاع النتيجة عند توصيل النقل بنجاح.
Disconnected	يتم إرجاع النتيجة عند قطع اتصال النقل بنجاح.
MessageAbandoned	يتم إرجاع النتيجة عند التخلي عن رسالة بنجاح.
MessageCompleted	يتم إرجاع النتيجة عند رفض رسالة بنجاح.
MessageEnqueued	يتم إرجاع النتيجة عند ترتيب رسالة في قائمة الانتظار بنجاح.
MessageRejected	يتم إرجاع النتيجة عند رفض رسالة بنجاح.
SharedAccessSignatureUpdated	يتم إرجاع النتيجة عند تحديث رمز SAS المميز بنجاح.
TransportConfigured	يتم إرجاع النتيجة عند تكوين النقل بنجاح.
ConnectionString	يصف المعلمات التي تمكن جهازا أو تطبيقا سحابيا من الاتصال بمركز Azure IoT.
ExponentialBackOffWithJitter	ينفذ التراجع الأسي باستخدام استراتيجية إعادة المحاولة Jitter. الدالة لحساب الفاصل الزمني التالي هي التالية (x هي إعادة المحاولة xth): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	نهج Stub الذي يمنع أي إعادة محاولة مبدئية. لا تتم إعادة محاولة العمليات.
RetryOperation	ينفذ المنطق الضروري لإعادة محاولة العمليات مثل الاتصال وتلقي رسائل C2D وإرسال بيانات تتبع الاستخدام والتحديثات المزدوجة وما إلى ذلك.
SharedAccessSignature	تستخدم الرموز المميزة لتوقيع الوصول المشترك لمصادقة الاتصال عند استخدام مفاتيح متماثلة (بدلا من شهادات x509) لتأمين الاتصال بمركز Azure IoT.

الواجهات

AuthenticationProvider	الواجهة التي يجب تنفيذها بواسطة العناصر المستخدمة لتوفير بيانات الاعتماد للنقلات التي يستخدمها عميل الجهاز للمصادقة مع مثيل مركز Azure IoT.
Receiver
RetryPolicy	واجهة تصف كائن نهج إعادة المحاولة. تتكون نهج إعادة المحاولة من شيئين خوارزمية تحسب في المرة التالية لإعادة المحاولة استنادا إلى الرقم الحالي أو عمليات إعادة المحاولة. عامل تصفية خطأ يقرر، استنادا إلى نوع الخطأ المستلم، ما إذا كان يجب أن تحدث إعادة المحاولة أم لا. يختبئ هذان المكونان خلف استدعاءين للأسلوب الموضحين في هذه الواجهة.
TransportConfig	بنية التكوين المستخدمة من قبل عمليات النقل والكائنات AuthenticationProvider لتخزين بيانات الاعتماد وتبادلها.
X509	الكائن المستخدم لتخزين شهادة X509 ومفتاح للنقل لاستخدامه. يتم تمرير هذا مباشرة إلى الكائنات منخفضة المستوى المستخدمة من قبل Node.js لتوصيل مأخذ توصيل TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

النوع أسماء مستعارة

BufferConvertible
ResultWithHttpResponse
Callback	يحدد النوع الذي يصف رد الاتصال العادي مع نتيجتين - واحدة هي الخطأ، والأخرى هي قيمة النتيجة.
DoubleValueCallback	يحدد النوع الذي يصف رد الاتصال مع نتيجتين.
ErrorCallback	يحدد النوع الذي يصف رد الاتصال بقيمة نتيجة الخطأ فقط.
HttpResponseCallback	يحدد النوع الذي يصف رد الاتصال بثلاث نتائج - الاستجابة واستجابة HTTP الأولية والخطأ.
NoErrorCallback	يحدد النوع الذي يصف رد الاتصال بقيمة نتيجة واحدة غير خطأ.
TripleValueCallback	يحدد النوع الذي يصف رد الاتصال العادي بثلاث نتائج - الأول هو خطأ، والآخران هما قيم النتيجة.

التعدادات

AuthenticationType

قم بتعيين نوع المصادقة المستخدمة من قبل AuthenticationProvider.

الوظائف

anHourFromNow()	إرجاع الثواني المنقضية منذ 1 يناير 1970 00:00:00 بالتوقيت العالمي المتفق عليه حتى ساعة واحدة من الآن.
encodeUriComponentStrict(string)

تفاصيل الوظيفة

anHourFromNow()

إرجاع الثواني المنقضية منذ 1 يناير 1970 00:00:00 بالتوقيت العالمي المتفق عليه حتى ساعة واحدة من الآن.

function anHourFromNow(): number

المرتجعات

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

المعلمات

str

string

المرتجعات

string