مشاركة عبر


Registry class

توفر فئة التسجيل الوصول إلى خدمة هوية جهاز IoT Hub. يجب على مستخدمي SDK إنشاء مثيل لهذه الفئة باستخدام إحدى أساليب المصنع: منConnectionString أو منSharedAccessSignature.

البروتوكول المستخدم لعمليات تسجيل هوية الجهاز هو HTTPS.

الأساليب

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)

إضافة تكوين إلى مركز IoT.

addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

إضافة صفيف من الأجهزة.

addModule(Module)
addModule(Module, HttpResponseCallback<any>)

أضف الوحدة النمطية المحددة إلى السجل.

applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

تطبيق التكوين المحدد على جهاز على IoT Hub

cancelJob(string)
cancelJob(string, Callback<JobStatus>)

إلغاء مهمة استيراد/تصدير مجمعة.

create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)

إنشاء هوية جهاز جديدة على مركز IoT.

createQuery(string, number)

إنشاء استعلام يمكن تشغيله على مثيل IoT Hub للعثور على معلومات حول الأجهزة أو الوظائف.

delete(string)
delete(string, HttpResponseCallback<any>)

إزالة هوية جهاز موجودة من مركز IoT.

exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)

تصدير الأجهزة إلى كائن ثنائي كبير الحجم في مهمة مجمعة.

exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

تصدير الأجهزة إلى كائن ثنائي كبير الحجم في مهمة مجمعة باستخدام هوية مكونة.

exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)

إنشاء كائن Registry من سلسلة الاتصال المحددة.

fromSharedAccessSignature(string)

إنشاء كائن Registry من توقيع الوصول المشترك المحدد.

fromTokenCredential(string, TokenCredential)

إنشاء كائن Registry من Azure TokenCredential المحدد.

get(string)
get(string, HttpResponseCallback<Device>)

طلب معلومات حول هوية جهاز موجودة على مركز IoT.

getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)

الحصول على تكوين واحد من IoT Hub

getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)

الحصول على جميع التكوينات على IoT Hub

getJob(string)
getJob(string, Callback<JobStatus>)

احصل على حالة مهمة استيراد/تصدير مجمعة.

getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)

الحصول على وحدة نمطية واحدة من جهاز على IoT Hub

getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)

الحصول على قائمة بجميع الوحدات النمطية على جهاز IoT Hub

getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)

يحصل على الوحدة النمطية المزدوجة للوحدة النمطية مع معرف الوحدة النمطية المحدد.

getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

الحصول على إحصائيات حول الأجهزة في سجل هوية الجهاز.

getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)

يحصل على Device Twin للجهاز مع معرف الجهاز المحدد.

importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)

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

importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

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

importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)

يطلب معلومات حول أول 1000 هوية جهاز على مركز IoT.

listJobs()
listJobs(HttpResponseCallback<any>)

سرد آخر مهام الاستيراد/التصدير (بما في ذلك مهام الاستيراد/التصدير النشطة، إن وجدت).

removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)

إزالة تكوين بالمعرف المحدد من IoT Hub

removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

تحديث صفيف من الأجهزة.

removeModule(Module, TripleValueCallback<any, any>)

إزالة الوحدة النمطية المحددة من السجل

removeModule(string | Module)
removeModule(string | Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)

يحدث هوية جهاز موجودة على مركز IoT بمعلومات الجهاز المحددة. يجب أن تتضمن المعلمة deviceInfo جميع الخصائص القابلة للتحديث. على سبيل المثال، إذا كان تحديث الخاصية status من disabled إلى enabled، يجب أن يحتوي كائن deviceInfo أيضا على statusReason والمصادقة (وخصائصه الفرعية) والقدرات وتعيين deviceScope إلى القيم الحالية للأجهزة أو ستتم إعادة تعيين هذه الخصائص. يوصى باستدعاء واجهة برمجة تطبيقات get أولا قبل إجراء تحديث.

updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)

تحديث تكوين في مركز IoT

updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

تحديث صفيف من الأجهزة. يجب أن تتضمن العناصر الفردية للمعلمة devices جميع الخصائص القابلة للتحديث. على سبيل المثال، إذا كان تحديث خاصية status من disabled إلى enabled، يجب أن يكون للعنصر أيضا statusReason والمصادقة (وخصائصها الفرعية) والقدرات وdeviceScope التي تم تعيينها إلى القيم الحالية للأجهزة أو سيتم إعادة تعيين هذه الخصائص. يوصى باستدعاء واجهة برمجة تطبيقات get أولا قبل إجراء تحديث.

updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)

تحديث كائن الوحدة النمطية المحدد في السجل

updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)

تحديث التوأم لوحدة نمطية معينة بالتصحيح المحدد.

updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)

يحدث Device Twin لجهاز معين بالتصحيح المحدد.

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

addConfiguration(Configuration)

function addConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>

المعلمات

configuration
Configuration

المرتجعات

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

إضافة تكوين إلى مركز IoT.

function addConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)

المعلمات

configuration
Configuration

عنصر من نوع الوحدة النمطية:azure-iothub. التكوين لإضافته إلى المركز

done

HttpResponseCallback<any>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، نص الاستجابة، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

addDevices(DeviceDescription[])

function addDevices(devices: DeviceDescription[]): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

المعلمات

devices

DeviceDescription[]

المرتجعات

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

إضافة صفيف من الأجهزة.

function addDevices(devices: DeviceDescription[], done?: HttpResponseCallback<BulkRegistryOperationResult>)

المعلمات

devices

DeviceDescription[]

صفيف من الكائنات التي يجب أن تتضمن خاصية deviceId قيمتها معرف جهاز صالح.

done

HttpResponseCallback<BulkRegistryOperationResult>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، و BulkRegistryOperationResult، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

addModule(Module)

function addModule(module: Module): Promise<ResultWithHttpResponse<any>>

المعلمات

module
Module

المرتجعات

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

أضف الوحدة النمطية المحددة إلى السجل.

function addModule(module: Module, done?: HttpResponseCallback<any>)

المعلمات

module
Module

كائن الوحدة النمطية لإضافته إلى السجل.

done

HttpResponseCallback<any>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، نص الاستجابة، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

applyConfigurationContentOnDevice(string, ConfigurationContent)

function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent): Promise<ResultWithHttpResponse<any>>

المعلمات

deviceId

string

المرتجعات

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

تطبيق التكوين المحدد على جهاز على IoT Hub

function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent, done?: HttpResponseCallback<any>)

المعلمات

deviceId

string

معرف الجهاز لتطبيق التكوين عليه

content
ConfigurationContent

التكوين الذي يجب تطبيقه

done

HttpResponseCallback<any>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، نص الاستجابة، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

cancelJob(string)

function cancelJob(jobId: string): Promise<JobStatus>

المعلمات

jobId

string

المرتجعات

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

إلغاء مهمة استيراد/تصدير مجمعة.

function cancelJob(jobId: string, done?: Callback<JobStatus>)

المعلمات

jobId

string

معرف الوظيفة التي يريد المستخدم الحصول على معلومات الحالة لها.

done

Callback<JobStatus>

الدالة الاختيارية لاستدعاء مع وسيطتين: كائن خطأ إذا حدث خطأ، (خال خلاف ذلك) وحالة (تم إلغاؤها) للوظيفة التي تم تمرير معرفها كوسيطة.

create(DeviceDescription)

function create(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>

المعلمات

deviceInfo
DeviceDescription

المرتجعات

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

إنشاء هوية جهاز جديدة على مركز IoT.

function create(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)

المعلمات

deviceInfo
DeviceDescription

يجب أن يتضمن الكائن خاصية deviceId مع معرف جهاز صالح.

done

HttpResponseCallback<Device>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، وعنصر Device يمثل هوية الجهاز التي تم إنشاؤها، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

createQuery(string, number)

إنشاء استعلام يمكن تشغيله على مثيل IoT Hub للعثور على معلومات حول الأجهزة أو الوظائف.

function createQuery(sqlQuery: string, pageSize?: number): Query

المعلمات

sqlQuery

string

الاستعلام المكتوب كسلسلة SQL.

pageSize

number

العدد المطلوب من النتائج لكل صفحة (اختياري. الافتراضي: 1000، الحد الأقصى: 10000).

المرتجعات

Query

delete(string)

function delete(deviceId: string): Promise<ResultWithHttpResponse<any>>

المعلمات

deviceId

string

المرتجعات

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

إزالة هوية جهاز موجودة من مركز IoT.

function delete(deviceId: string, done?: HttpResponseCallback<any>)

المعلمات

deviceId

string

معرف هوية جهاز موجودة.

done

HttpResponseCallback<any>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، ووسيطة فارغة دائما (للتناسق مع الأساليب الأخرى)، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

exportDevicesToBlob(string, boolean)

function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>

المعلمات

outputBlobContainerUri

string

excludeKeys

boolean

المرتجعات

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

تصدير الأجهزة إلى كائن ثنائي كبير الحجم في مهمة مجمعة.

function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)

المعلمات

outputBlobContainerUri

string

سيتم إنشاء URI إلى حاوية حيث سيتم إنشاء كائن ثنائي كبير الحجم يسمى 'devices.txt' يحتوي على قائمة الأجهزة.

excludeKeys

boolean

منطقي يشير إلى ما إذا كان يجب استبعاد مفاتيح الأمان من البيانات المصدرة.

done

Callback<JobStatus>

الدالة الاختيارية التي يجب استدعاؤها عند إنشاء المهمة، مع وسيطتين: كائن خطأ إذا حدث خطأ، (خال خلاف ذلك) وحالة المهمة التي يمكن استخدامها لتعقب تقدم تصدير الأجهزة.

exportDevicesToBlobByIdentity(string, boolean)

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>

المعلمات

outputBlobContainerUri

string

excludeKeys

boolean

المرتجعات

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

تصدير الأجهزة إلى كائن ثنائي كبير الحجم في مهمة مجمعة باستخدام هوية مكونة.

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)

المعلمات

outputBlobContainerUri

string

سيتم إنشاء URI إلى حاوية حيث سيتم إنشاء كائن ثنائي كبير الحجم يسمى 'devices.txt' يحتوي على قائمة الأجهزة.

excludeKeys

boolean

منطقي يشير إلى ما إذا كان يجب استبعاد مفاتيح الأمان من البيانات المصدرة.

done

Callback<JobStatus>

الدالة الاختيارية التي يجب استدعاؤها عند إنشاء المهمة، مع وسيطتين: كائن خطأ إذا حدث خطأ، (خال خلاف ذلك) وحالة المهمة التي يمكن استخدامها لتعقب تقدم تصدير الأجهزة.

exportDevicesToBlobByIdentity(string, boolean, string)

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string): Promise<JobStatus>

المعلمات

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

المرتجعات

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string, done: Callback<JobStatus>)

المعلمات

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

done

Callback<JobStatus>

fromConnectionString(string)

إنشاء كائن Registry من سلسلة الاتصال المحددة.

static function fromConnectionString(value: string): Registry

المعلمات

value

string

سلسلة اتصال تغلف أذونات التسجيل المناسبة (للقراءة و/أو الكتابة).

المرتجعات

fromSharedAccessSignature(string)

إنشاء كائن Registry من توقيع الوصول المشترك المحدد.

static function fromSharedAccessSignature(value: string): Registry

المعلمات

value

string

توقيع وصول مشترك يغلف أذونات التسجيل المناسبة (للقراءة و/أو الكتابة).

المرتجعات

fromTokenCredential(string, TokenCredential)

إنشاء كائن Registry من Azure TokenCredential المحدد.

static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): Registry

المعلمات

hostName

string

اسم المضيف لخدمة Azure.

tokenCredential
TokenCredential

Azure TokenCredential يستخدم للمصادقة مع خدمة Azure

المرتجعات

get(string)

function get(deviceId: string): Promise<ResultWithHttpResponse<Device>>

المعلمات

deviceId

string

المرتجعات

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

طلب معلومات حول هوية جهاز موجودة على مركز IoT.

function get(deviceId: string, done?: HttpResponseCallback<Device>)

المعلمات

deviceId

string

معرف هوية جهاز موجودة.

done

HttpResponseCallback<Device>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، وعنصر Device يمثل هوية الجهاز التي تم إنشاؤها، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

getConfiguration(string)

function getConfiguration(configurationId: string): Promise<ResultWithHttpResponse<Configuration>>

المعلمات

configurationId

string

المرتجعات

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

الحصول على تكوين واحد من IoT Hub

function getConfiguration(configurationId: string, done?: HttpResponseCallback<Configuration>)

المعلمات

configurationId

string

معرف التكوين الذي تريد استرداده

done

HttpResponseCallback<Configuration>

رد الاتصال الاختياري الذي سيتم استدعاؤه إما مع كائن خطأ أو وحدة نمطية:azure-iothub. كائن التكوين مع تفاصيل التكوين.

getConfigurations()

function getConfigurations(): Promise<ResultWithHttpResponse<Configuration[]>>

المرتجعات

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

الحصول على جميع التكوينات على IoT Hub

function getConfigurations(done?: HttpResponseCallback<Configuration[]>)

المعلمات

done

HttpResponseCallback<Configuration[]>

رد الاتصال الاختياري الذي سيتم استدعاؤه إما مع كائن خطأ أو صفيف من الوحدة النمطية:azure-iothub. كائنات التكوين لجميع التكوينات.

getJob(string)

function getJob(jobId: string): Promise<JobStatus>

المعلمات

jobId

string

المرتجعات

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

احصل على حالة مهمة استيراد/تصدير مجمعة.

function getJob(jobId: string, done?: Callback<JobStatus>)

المعلمات

jobId

string

معرف الوظيفة التي يريد المستخدم الحصول على معلومات الحالة لها.

done

Callback<JobStatus>

الدالة الاختيارية لاستدعاء مع وسيطتين: كائن خطأ إذا حدث خطأ، (خال خلاف ذلك) وحالة المهمة التي تم تمرير معرفها كوسيطة.

getModule(string, string)

function getModule(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Module>>

المعلمات

deviceId

string

moduleId

string

المرتجعات

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

الحصول على وحدة نمطية واحدة من جهاز على IoT Hub

function getModule(deviceId: string, moduleId: string, done?: HttpResponseCallback<Module>)

المعلمات

deviceId

string

معرف الجهاز الذي يمتلك الوحدة النمطية.

moduleId

string

معرف الوحدة النمطية المراد استرداده

done

HttpResponseCallback<Module>

رد الاتصال الاختياري الذي سيتم استدعاؤه إما مع كائن خطأ أو الوحدة النمطية:azure-iothub. كائن الوحدة النمطية للوحدة النمطية المطلوبة

getModulesOnDevice(string)

function getModulesOnDevice(deviceId: string): Promise<ResultWithHttpResponse<Module[]>>

المعلمات

deviceId

string

المرتجعات

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

الحصول على قائمة بجميع الوحدات النمطية على جهاز IoT Hub

function getModulesOnDevice(deviceId: string, done?: HttpResponseCallback<Module[]>)

المعلمات

deviceId

string

معرف الجهاز الذي نحصل على وحدات نمطية له

done

HttpResponseCallback<Module[]>

رد الاتصال الاختياري الذي سيتم استدعاؤه إما مع كائن خطأ أو صفيف من الوحدة النمطية:azure-iothub. كائنات الوحدة النمطية لجميع الوحدات النمطية.

getModuleTwin(string, string)

function getModuleTwin(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Twin>>

المعلمات

deviceId

string

moduleId

string

المرتجعات

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

يحصل على الوحدة النمطية المزدوجة للوحدة النمطية مع معرف الوحدة النمطية المحدد.

function getModuleTwin(deviceId: string, moduleId: string, done?: HttpResponseCallback<Twin>)

المعلمات

deviceId

string

معرف الجهاز.

moduleId

string

معرف الوحدة النمطية.

done

HttpResponseCallback<Twin>

رد الاتصال الاختياري الذي سيتم استدعاؤه إما مع كائن خطأ أو مثيل الوحدة النمطية المزدوجة.

getRegistryStatistics()

function getRegistryStatistics(): Promise<ResultWithHttpResponse<RegistryStatistics>>

المرتجعات

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

الحصول على إحصائيات حول الأجهزة في سجل هوية الجهاز.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

المعلمات

done

HttpResponseCallback<RegistryStatistics>

رد الاتصال الاختياري الذي سيتم استدعاؤه إما باستخدام كائن خطأ أو إحصائيات سجل الجهاز.

getTwin(string)

function getTwin(deviceId: string): Promise<ResultWithHttpResponse<Twin>>

المعلمات

deviceId

string

المرتجعات

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

يحصل على Device Twin للجهاز مع معرف الجهاز المحدد.

function getTwin(deviceId: string, done?: HttpResponseCallback<Twin>)

المعلمات

deviceId

string

معرف الجهاز.

done

HttpResponseCallback<Twin>

رد الاتصال الاختياري الذي سيتم استدعاؤه إما مع كائن خطأ أو مثيل الجهاز المزدوج.

importDevicesFromBlob(string, string)

function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>

المعلمات

inputBlobContainerUri

string

outputBlobContainerUri

string

المرتجعات

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

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

function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)

المعلمات

inputBlobContainerUri

string

URI إلى حاوية مع كائن ثنائي كبير الحجم يسمى 'devices.txt' يحتوي على قائمة بالأجهزة المراد استيرادها.

outputBlobContainerUri

string

URI إلى حاوية حيث سيتم إنشاء كائن ثنائي كبير الحجم مع سجلات عملية الاستيراد.

done

Callback<JobStatus>

الدالة الاختيارية التي يجب استدعاؤها عند إنشاء المهمة، مع وسيطتين: كائن خطأ إذا حدث خطأ، (خال خلاف ذلك) وحالة المهمة التي يمكن استخدامها لتعقب تقدم استيراد الأجهزة.

importDevicesFromBlobByIdentity(string, string)

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>

المعلمات

inputBlobContainerUri

string

outputBlobContainerUri

string

المرتجعات

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

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

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)

المعلمات

inputBlobContainerUri

string

URI إلى حاوية مع كائن ثنائي كبير الحجم يسمى 'devices.txt' يحتوي على قائمة بالأجهزة المراد استيرادها.

outputBlobContainerUri

string

URI إلى حاوية حيث سيتم إنشاء كائن ثنائي كبير الحجم مع سجلات عملية الاستيراد.

done

Callback<JobStatus>

الدالة الاختيارية التي يجب استدعاؤها عند إنشاء المهمة، مع وسيطتين: كائن خطأ إذا حدث خطأ، (خال خلاف ذلك) وحالة المهمة التي يمكن استخدامها لتعقب تقدم استيراد الأجهزة.

importDevicesFromBlobByIdentity(string, string, string)

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string): Promise<JobStatus>

المعلمات

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

المرتجعات

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string, done: Callback<JobStatus>)

المعلمات

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

done

Callback<JobStatus>

list()

function list(): Promise<ResultWithHttpResponse<Device[]>>

المرتجعات

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

يطلب معلومات حول أول 1000 هوية جهاز على مركز IoT.

function list(done?: HttpResponseCallback<Device[]>)

المعلمات

done

HttpResponseCallback<Device[]>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، ومصفوفة من عناصر الجهاز التي تمثل هويات الجهاز المدرجة، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

listJobs()

function listJobs(): Promise<ResultWithHttpResponse<any>>

المرتجعات

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

سرد آخر مهام الاستيراد/التصدير (بما في ذلك مهام الاستيراد/التصدير النشطة، إن وجدت).

function listJobs(done?: HttpResponseCallback<any>)

المعلمات

done

HttpResponseCallback<any>

الدالة الاختيارية لاستدعاء مع وسيطتين: كائن خطأ إذا حدث خطأ، (خال خلاف ذلك) وقائمة المهام السابقة كوسيطة.

removeConfiguration(string)

function removeConfiguration(configurationId: string): Promise<ResultWithHttpResponse<any>>

المعلمات

configurationId

string

المرتجعات

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

إزالة تكوين بالمعرف المحدد من IoT Hub

function removeConfiguration(configurationId: string, done?: HttpResponseCallback<any>)

المعلمات

configurationId

string

معرف التكوين المراد إزالته

done

HttpResponseCallback<any>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، نص الاستجابة، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

removeDevices(DeviceDescription[], boolean)

function removeDevices(devices: DeviceDescription[], forceRemove: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

المعلمات

devices

DeviceDescription[]

forceRemove

boolean

المرتجعات

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

تحديث صفيف من الأجهزة.

function removeDevices(devices: DeviceDescription[], forceRemove: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)

المعلمات

devices

DeviceDescription[]

صفيف من الكائنات التي يجب أن تتضمن خاصية deviceId قيمتها معرف جهاز صالح.

forceRemove

boolean

إذا كان forceRemove صحيحا، فستتم إزالة الجهاز بغض النظر عن علامة etag. وإلا يجب أن تتطابق etags.

done

HttpResponseCallback<BulkRegistryOperationResult>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، و BulkRegistryOperationResult، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

removeModule(Module, TripleValueCallback<any, any>)

إزالة الوحدة النمطية المحددة من السجل

function removeModule(module: Module, done?: TripleValueCallback<any, any>)

المعلمات

module
Module
done

TripleValueCallback<any, any>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، نص الاستجابة، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

removeModule(string | Module)

function removeModule(moduleOrDeviceId: string | Module): Promise<ResultWithHttpResponse<any>>

المعلمات

moduleOrDeviceId

string | Module

المرتجعات

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

function removeModule(moduleOrDeviceId: string | Module, moduleId: string): Promise<ResultWithHttpResponse<any>>

المعلمات

moduleOrDeviceId

string | Module

moduleId

string

المرتجعات

Promise<ResultWithHttpResponse<any>>

removeModule(string, string, TripleValueCallback<any, any>)

function removeModule(deviceId: string, moduleId: string, done: TripleValueCallback<any, any>)

المعلمات

deviceId

string

moduleId

string

done

TripleValueCallback<any, any>

update(DeviceDescription)

function update(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>

المعلمات

deviceInfo
DeviceDescription

المرتجعات

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

يحدث هوية جهاز موجودة على مركز IoT بمعلومات الجهاز المحددة. يجب أن تتضمن المعلمة deviceInfo جميع الخصائص القابلة للتحديث. على سبيل المثال، إذا كان تحديث الخاصية status من disabled إلى enabled، يجب أن يحتوي كائن deviceInfo أيضا على statusReason والمصادقة (وخصائصه الفرعية) والقدرات وتعيين deviceScope إلى القيم الحالية للأجهزة أو ستتم إعادة تعيين هذه الخصائص. يوصى باستدعاء واجهة برمجة تطبيقات get أولا قبل إجراء تحديث.

function update(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)

المعلمات

deviceInfo
DeviceDescription

كائن يجب أن يتضمن خاصية deviceId تكون قيمتها معرف جهاز صالح.

done

HttpResponseCallback<Device>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، وعنصر Device يمثل هوية الجهاز المحدثة، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

updateConfiguration(Configuration)

function updateConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>

المعلمات

configuration
Configuration

المرتجعات

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

function updateConfiguration(configuration: Configuration, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>

المعلمات

configuration
Configuration
forceUpdate

boolean

المرتجعات

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

function updateConfiguration(configuration: Configuration, forceUpdate: boolean, done: HttpResponseCallback<any>)

المعلمات

configuration
Configuration
forceUpdate

boolean

done

HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

تحديث تكوين في مركز IoT

function updateConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)

المعلمات

configuration
Configuration

عنصر من نوع الوحدة النمطية:azure-iothub. التكوين لإضافته إلى المركز

done

HttpResponseCallback<any>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، نص الاستجابة، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

updateDevices(DeviceDescription[], boolean)

function updateDevices(devices: DeviceDescription[], forceUpdate: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

المعلمات

devices

DeviceDescription[]

forceUpdate

boolean

المرتجعات

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

تحديث صفيف من الأجهزة. يجب أن تتضمن العناصر الفردية للمعلمة devices جميع الخصائص القابلة للتحديث. على سبيل المثال، إذا كان تحديث خاصية status من disabled إلى enabled، يجب أن يكون للعنصر أيضا statusReason والمصادقة (وخصائصها الفرعية) والقدرات وdeviceScope التي تم تعيينها إلى القيم الحالية للأجهزة أو سيتم إعادة تعيين هذه الخصائص. يوصى باستدعاء واجهة برمجة تطبيقات get أولا قبل إجراء تحديث.

function updateDevices(devices: DeviceDescription[], forceUpdate: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)

المعلمات

devices

DeviceDescription[]

صفيف من الكائنات التي يجب أن تتضمن خاصية deviceId قيمتها معرف جهاز صالح.

forceUpdate

boolean

إذا كان forceUpdate صحيحا، تحديث الجهاز بغض النظر عن etag. وإلا يجب أن تتطابق etags.

done

HttpResponseCallback<BulkRegistryOperationResult>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، و BulkRegistryOperationResult، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

updateModule(Module)

function updateModule(module: Module): Promise<ResultWithHttpResponse<any>>

المعلمات

module
Module

المرتجعات

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

function updateModule(module: Module, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>

المعلمات

module
Module
forceUpdate

boolean

المرتجعات

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

function updateModule(module: Module, forceUpdate: boolean, done: HttpResponseCallback<any>)

المعلمات

module
Module
forceUpdate

boolean

done

HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

تحديث كائن الوحدة النمطية المحدد في السجل

function updateModule(module: Module, done?: TripleValueCallback<any, any>)

المعلمات

module
Module

كائن الوحدة النمطية المراد تحديثه.

done

TripleValueCallback<any, any>

الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، نص الاستجابة، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

updateModuleTwin(string, string, any, string)

function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>

المعلمات

deviceId

string

moduleId

string

patch

any

etag

string

المرتجعات

Promise<ResultWithHttpResponse<Twin>>

updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)

تحديث التوأم لوحدة نمطية معينة بالتصحيح المحدد.

function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)

المعلمات

deviceId

string

معرف الجهاز.

moduleId

string

معرف الوحدة النمطية

patch

any

الخصائص والعلامات المطلوبة لتصحيح الوحدة النمطية المزدوجة بها.

etag

string

أحدث etag لهذه الوحدة النمطية المزدوجة أو '*' لفرض تحديث حتى إذا تم تحديث الوحدة المزدوجة منذ الحصول على etag.

done

HttpResponseCallback<Twin>

رد الاتصال الاختياري الذي سيتم استدعاؤه إما مع كائن خطأ أو مثيل الوحدة النمطية المزدوجة.

updateTwin(string, any, string)

function updateTwin(deviceId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>

المعلمات

deviceId

string

patch

any

etag

string

المرتجعات

Promise<ResultWithHttpResponse<Twin>>

updateTwin(string, any, string, HttpResponseCallback<Twin>)

يحدث Device Twin لجهاز معين بالتصحيح المحدد.

function updateTwin(deviceId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)

المعلمات

deviceId

string

معرف الجهاز.

patch

any

الخصائص والعلامات المطلوبة لتصحيح الجهاز المزدوج مع.

etag

string

أحدث etag لهذا الجهاز المزدوج أو '*' لفرض تحديث حتى إذا تم تحديث توأم الجهاز منذ الحصول على etag.

done

HttpResponseCallback<Twin>

رد الاتصال الاختياري الذي سيتم استدعاؤه إما مع كائن خطأ أو مثيل الجهاز المزدوج.