Registry class

Paket:

azure-iothub

Kelas Registri menyediakan akses ke layanan identitas perangkat IoT Hub. Pengguna SDK harus membuat instans kelas ini dengan salah satu metode pabrik: dariConnectionString atau dariSharedAccessSignature.

Protokol yang digunakan untuk operasi registri identitas perangkat adalah HTTPS.

Metode

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	Tambahkan konfigurasi ke hub IoT.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Menambahkan array perangkat.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Tambahkan modul yang diberikan ke registri.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	Menerapkan konfigurasi yang diberikan ke perangkat di IoT Hub
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Batalkan pekerjaan impor/ekspor massal.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	Membuat identitas perangkat baru di hub IoT.
createQuery(string, number)	Membuat kueri yang dapat dijalankan pada instans IoT Hub untuk menemukan informasi tentang perangkat atau pekerjaan.
delete(string)
delete(string, HttpResponseCallback<any>)	Menghapus identitas perangkat yang ada dari hub IoT.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	Ekspor perangkat ke blob dalam pekerjaan massal.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Ekspor perangkat ke blob dalam pekerjaan massal menggunakan identitas yang dikonfigurasi.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Membuat objek Registri dari string koneksi yang diberikan.
fromSharedAccessSignature(string)	Membuat objek Registri dari tanda tangan akses bersama yang diberikan.
fromTokenCredential(string, TokenCredential)	Membuat objek Registri dari Azure TokenCredential yang diberikan.
get(string)
get(string, HttpResponseCallback<Device>)	Meminta informasi tentang identitas perangkat yang ada di hub IoT.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	Mendapatkan satu konfigurasi dari IoT Hub
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Mendapatkan semua konfigurasi di IoT Hub
getJob(string)
getJob(string, Callback<JobStatus>)	Dapatkan status pekerjaan impor/ekspor massal.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	Mendapatkan satu modul dari perangkat di IoT Hub
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	Mendapatkan daftar semua modul di perangkat IoT Hub
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Mendapatkan Module Twin dari modul dengan pengidentifikasi modul yang ditentukan.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Mendapatkan statistik tentang perangkat di registri identitas perangkat.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Mendapatkan Device Twin perangkat dengan pengidentifikasi perangkat yang ditentukan.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Mengimpor perangkat dari blob dalam pekerjaan massal.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Mengimpor perangkat dari blob dalam pekerjaan massal menggunakan identitas yang dikonfigurasi.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	Meminta informasi tentang 1000 identitas perangkat pertama di hub IoT.
listJobs()
listJobs(HttpResponseCallback<any>)	Cantumkan pekerjaan impor/ekspor terakhir (termasuk yang aktif, jika ada).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	Menghapus konfigurasi dengan ID yang diberikan dari IoT Hub
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Memperbarui array perangkat.
removeModule(Module, TripleValueCallback<any, any>)	Menghapus modul yang diberikan dari registri
removeModule(string | Module)
removeModule(string | Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	Memperbarui identitas perangkat yang ada di hub IoT dengan informasi perangkat yang diberikan. Parameter deviceInfo harus menyertakan semua properti yang dapat diperbarui. Misalnya, jika memperbarui properti status dari disabled ke enabled, objek deviceInfo juga harus memiliki statusReason, autentikasi (dan sub-propertinya), kemampuan, dan deviceScope yang diatur ke nilai perangkat saat ini atau properti tersebut akan diatur ulang. Disarankan agar api get dipanggil terlebih dahulu sebelum melakukan pembaruan.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	Memperbarui konfigurasi di hub IoT
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Memperbarui array perangkat. Elemen individual parameter devices harus menyertakan semua properti yang dapat diperbarui. Misalnya, jika memperbarui properti status dari disabled ke enabled, objek juga harus memiliki statusReason, autentikasi (dan sub-propertinya), kemampuan, dan deviceScope yang diatur ke nilai perangkat saat ini atau properti tersebut akan diatur ulang. Disarankan agar api get dipanggil terlebih dahulu sebelum melakukan pembaruan.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	Memperbarui objek modul yang diberikan dalam registri
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Memperbarui Twin modul tertentu dengan patch yang diberikan.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Memperbarui Device Twin dari perangkat tertentu dengan patch yang diberikan.

Detail Metode

addConfiguration(Configuration)

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

Parameter

configuration

Configuration

Mengembalikan

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

Tambahkan konfigurasi ke hub IoT.

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

Parameter

configuration

Configuration

Objek jenis modul:azure-iothub. Konfigurasi untuk ditambahkan ke hub

done

HttpResponseCallback<any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), isi respons, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

addDevices(DeviceDescription[])

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

Parameter

devices

DeviceDescription[]

Mengembalikan

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Menambahkan array perangkat.

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

Parameter

devices

DeviceDescription[]

Array objek yang harus menyertakan properti deviceId yang nilainya adalah pengidentifikasi perangkat yang valid.

done

HttpResponseCallback<BulkRegistryOperationResult>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), BulkRegistryOperationResult dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

addModule(Module)

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

Parameter

module

Module

Mengembalikan

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Tambahkan modul yang diberikan ke registri.

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

Parameter

module

Module

Objek modul untuk ditambahkan ke registri.

done

HttpResponseCallback<any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), isi respons, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

applyConfigurationContentOnDevice(string, ConfigurationContent)

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

Parameter

deviceId

string

content

ConfigurationContent

Mengembalikan

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Menerapkan konfigurasi yang diberikan ke perangkat di IoT Hub

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

Parameter

deviceId

string

ID perangkat untuk menerapkan konfigurasi ke

content

ConfigurationContent

Konfigurasi yang akan diterapkan

done

HttpResponseCallback<any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), isi respons, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

cancelJob(string)

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

Parameter

jobId

string

Mengembalikan

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Batalkan pekerjaan impor/ekspor massal.

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

Parameter

jobId

string

Pengidentifikasi pekerjaan tempat pengguna ingin mendapatkan informasi status.

done

Callback<JobStatus>

Fungsi opsional untuk memanggil dengan dua argumen: objek kesalahan jika kesalahan terjadi, (null sebaliknya) dan status (dibatalkan) pekerjaan yang pengidentifikasinya diteruskan sebagai argumen.

create(DeviceDescription)

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

Parameter

deviceInfo

DeviceDescription

Mengembalikan

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

Membuat identitas perangkat baru di hub IoT.

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

Parameter

deviceInfo

DeviceDescription

Objek harus menyertakan properti deviceId dengan pengidentifikasi perangkat yang valid.

done

HttpResponseCallback<Device>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (dapat null), objek Perangkat yang mewakili identitas perangkat yang dibuat, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

createQuery(string, number)

Membuat kueri yang dapat dijalankan pada instans IoT Hub untuk menemukan informasi tentang perangkat atau pekerjaan.

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

Parameter

sqlQuery

string

Kueri yang ditulis sebagai string SQL.

pageSize

number

Jumlah hasil yang diinginkan per halaman (opsional. default: 1000, maks: 10000).

Mengembalikan

Query

delete(string)

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

Parameter

deviceId

string

Mengembalikan

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

Menghapus identitas perangkat yang ada dari hub IoT.

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

Parameter

deviceId

string

Pengidentifikasi identitas perangkat yang ada.

done

HttpResponseCallback<any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), argumen always-null (untuk konsistensi dengan metode lain), dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

exportDevicesToBlob(string, boolean)

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

Parameter

outputBlobContainerUri

string

excludeKeys

boolean

Mengembalikan

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Ekspor perangkat ke blob dalam pekerjaan massal.

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

Parameter

outputBlobContainerUri

string

URI ke kontainer tempat blob bernama 'devices.txt' akan dibuat yang berisi daftar perangkat.

excludeKeys

boolean

Boolean menunjukkan apakah kunci keamanan harus dikecualikan dari data yang diekspor.

done

Callback<JobStatus>

Fungsi opsional untuk memanggil ketika pekerjaan telah dibuat, dengan dua argumen: objek kesalahan jika kesalahan terjadi, (null sebaliknya) dan status pekerjaan yang dapat digunakan untuk melacak kemajuan ekspor perangkat.

exportDevicesToBlobByIdentity(string, boolean)

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

Parameter

outputBlobContainerUri

string

excludeKeys

boolean

Mengembalikan

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Ekspor perangkat ke blob dalam pekerjaan massal menggunakan identitas yang dikonfigurasi.

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

Parameter

outputBlobContainerUri

string

URI ke kontainer tempat blob bernama 'devices.txt' akan dibuat yang berisi daftar perangkat.

excludeKeys

boolean

Boolean menunjukkan apakah kunci keamanan harus dikecualikan dari data yang diekspor.

done

Callback<JobStatus>

Fungsi opsional untuk memanggil ketika pekerjaan telah dibuat, dengan dua argumen: objek kesalahan jika kesalahan terjadi, (null sebaliknya) dan status pekerjaan yang dapat digunakan untuk melacak kemajuan ekspor perangkat.

exportDevicesToBlobByIdentity(string, boolean, string)

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

Parameter

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

Mengembalikan

Promise<JobStatus>

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

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

Parameter

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

done

Callback<JobStatus>

fromConnectionString(string)

Membuat objek Registri dari string koneksi yang diberikan.

static function fromConnectionString(value: string): Registry

Parameter

value

string

String koneksi yang merangkum izin Registri yang sesuai (baca dan/atau tulis).

Mengembalikan

Registry

fromSharedAccessSignature(string)

Membuat objek Registri dari tanda tangan akses bersama yang diberikan.

static function fromSharedAccessSignature(value: string): Registry

Parameter

value

string

Tanda tangan akses bersama yang merangkum izin Registri yang sesuai (baca dan/atau tulis).

Mengembalikan

Registry

fromTokenCredential(string, TokenCredential)

Membuat objek Registri dari Azure TokenCredential yang diberikan.

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

Parameter

hostName

string

Nama host layanan Azure.

tokenCredential

TokenCredential

Azure TokenCredential yang digunakan untuk mengautentikasi dengan layanan Azure

Mengembalikan

Registry

get(string)

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

Parameter

deviceId

string

Mengembalikan

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

Meminta informasi tentang identitas perangkat yang ada di hub IoT.

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

Parameter

deviceId

string

Pengidentifikasi identitas perangkat yang ada.

done

HttpResponseCallback<Device>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (dapat null), objek Perangkat yang mewakili identitas perangkat yang dibuat, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

getConfiguration(string)

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

Parameter

configurationId

string

Mengembalikan

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

Mendapatkan satu konfigurasi dari IoT Hub

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

Parameter

configurationId

string

ID konfigurasi yang Anda gunakan untuk mengambil

done

HttpResponseCallback<Configuration>

Panggilan balik opsional yang akan dipanggil dengan objek Kesalahan atau modul:azure-iothub. Objek konfigurasi dengan detail konfigurasi.

getConfigurations()

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

Mengembalikan

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Mendapatkan semua konfigurasi di IoT Hub

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

Parameter

done

HttpResponseCallback<Configuration[]>

Panggilan balik opsional yang akan dipanggil dengan objek Kesalahan atau array modul:azure-iothub. Objek konfigurasi untuk semua konfigurasi.

getJob(string)

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

Parameter

jobId

string

Mengembalikan

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Dapatkan status pekerjaan impor/ekspor massal.

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

Parameter

jobId

string

Pengidentifikasi pekerjaan tempat pengguna ingin mendapatkan informasi status.

done

Callback<JobStatus>

Fungsi opsional untuk memanggil dengan dua argumen: objek kesalahan jika kesalahan terjadi, (null sebaliknya) dan status pekerjaan yang pengidentifikasinya diteruskan sebagai argumen.

getModule(string, string)

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

Parameter

deviceId

string

moduleId

string

Mengembalikan

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

Mendapatkan satu modul dari perangkat di IoT Hub

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

Parameter

deviceId

string

ID perangkat yang memiliki modul.

moduleId

string

ID modul untuk diambil

done

HttpResponseCallback<Module>

Panggilan balik opsional yang akan dipanggil dengan objek Kesalahan atau modul:azure-iothub. Objek modul untuk modul yang diminta

getModulesOnDevice(string)

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

Parameter

deviceId

string

Mengembalikan

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

Mendapatkan daftar semua modul di perangkat IoT Hub

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

Parameter

deviceId

string

ID perangkat tempat kami mendapatkan modul

done

HttpResponseCallback<Module[]>

Panggilan balik opsional yang akan dipanggil dengan objek Kesalahan atau array modul:azure-iothub. Objek modul untuk semua modul.

getModuleTwin(string, string)

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

Parameter

deviceId

string

moduleId

string

Mengembalikan

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Mendapatkan Module Twin dari modul dengan pengidentifikasi modul yang ditentukan.

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

Parameter

deviceId

string

Pengidentifikasi perangkat.

moduleId

string

Pengidentifikasi modul.

done

HttpResponseCallback<Twin>

Panggilan balik opsional yang akan dipanggil dengan objek Kesalahan atau instans kembar modul.

getRegistryStatistics()

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

Mengembalikan

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Mendapatkan statistik tentang perangkat di registri identitas perangkat.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Parameter

done

HttpResponseCallback<RegistryStatistics>

Panggilan balik opsional yang akan dipanggil dengan objek Kesalahan atau statistik registri perangkat.

getTwin(string)

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

Parameter

deviceId

string

Mengembalikan

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Mendapatkan Device Twin perangkat dengan pengidentifikasi perangkat yang ditentukan.

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

Parameter

deviceId

string

Pengidentifikasi perangkat.

done

HttpResponseCallback<Twin>

Panggilan balik opsional yang akan dipanggil dengan objek Kesalahan atau instans kembar perangkat.

importDevicesFromBlob(string, string)

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

Parameter

inputBlobContainerUri

string

outputBlobContainerUri

string

Mengembalikan

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

Mengimpor perangkat dari blob dalam pekerjaan massal.

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

Parameter

inputBlobContainerUri

string

URI ke kontainer dengan blob bernama 'devices.txt' yang berisi daftar perangkat yang akan diimpor.

outputBlobContainerUri

string

URI ke kontainer tempat blob akan dibuat dengan log proses impor.

done

Callback<JobStatus>

Fungsi opsional untuk memanggil ketika pekerjaan telah dibuat, dengan dua argumen: objek kesalahan jika kesalahan terjadi, (null sebaliknya) dan status pekerjaan yang dapat digunakan untuk melacak kemajuan impor perangkat.

importDevicesFromBlobByIdentity(string, string)

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

Parameter

inputBlobContainerUri

string

outputBlobContainerUri

string

Mengembalikan

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Mengimpor perangkat dari blob dalam pekerjaan massal menggunakan identitas yang dikonfigurasi.

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

Parameter

inputBlobContainerUri

string

URI ke kontainer dengan blob bernama 'devices.txt' yang berisi daftar perangkat yang akan diimpor.

outputBlobContainerUri

string

URI ke kontainer tempat blob akan dibuat dengan log proses impor.

done

Callback<JobStatus>

Fungsi opsional untuk memanggil ketika pekerjaan telah dibuat, dengan dua argumen: objek kesalahan jika kesalahan terjadi, (null sebaliknya) dan status pekerjaan yang dapat digunakan untuk melacak kemajuan impor perangkat.

importDevicesFromBlobByIdentity(string, string, string)

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

Parameter

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

Mengembalikan

Promise<JobStatus>

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

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

Parameter

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

done

Callback<JobStatus>

list()

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

Mengembalikan

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

Meminta informasi tentang 1000 identitas perangkat pertama di hub IoT.

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

Parameter

done

HttpResponseCallback<Device[]>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), array objek Perangkat yang mewakili identitas perangkat yang tercantum, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

listJobs()

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

Mengembalikan

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Cantumkan pekerjaan impor/ekspor terakhir (termasuk yang aktif, jika ada).

function listJobs(done?: HttpResponseCallback<any>)

Parameter

done

HttpResponseCallback<any>

Fungsi opsional untuk memanggil dengan dua argumen: objek kesalahan jika kesalahan terjadi, (null sebaliknya) dan daftar pekerjaan sebelumnya sebagai argumen.

removeConfiguration(string)

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

Parameter

configurationId

string

Mengembalikan

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

Menghapus konfigurasi dengan ID yang diberikan dari IoT Hub

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

Parameter

configurationId

string

ID konfigurasi yang akan dihapus

done

HttpResponseCallback<any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), isi respons, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

removeDevices(DeviceDescription[], boolean)

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

Parameter

devices

DeviceDescription[]

forceRemove

boolean

Mengembalikan

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Memperbarui array perangkat.

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

Parameter

devices

DeviceDescription[]

Array objek yang harus menyertakan properti deviceId yang nilainya adalah pengidentifikasi perangkat yang valid.

forceRemove

boolean

jika forceRemove benar, maka perangkat akan dihapus terlepas dari etag. Jika tidak, etag harus cocok.

done

HttpResponseCallback<BulkRegistryOperationResult>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), BulkRegistryOperationResult dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

removeModule(Module, TripleValueCallback<any, any>)

Menghapus modul yang diberikan dari registri

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

Parameter

module

Module

done

TripleValueCallback<any, any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), isi respons, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

removeModule(string | Module)

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

Parameter

moduleOrDeviceId

string | Module

Mengembalikan

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

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

Parameter

moduleOrDeviceId

string | Module

moduleId

string

Mengembalikan

Promise<ResultWithHttpResponse<any>>

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

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

Parameter

deviceId

string

moduleId

string

done

TripleValueCallback<any, any>

update(DeviceDescription)

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

Parameter

deviceInfo

DeviceDescription

Mengembalikan

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

Memperbarui identitas perangkat yang ada di hub IoT dengan informasi perangkat yang diberikan. Parameter deviceInfo harus menyertakan semua properti yang dapat diperbarui. Misalnya, jika memperbarui properti status dari disabled ke enabled, objek deviceInfo juga harus memiliki statusReason, autentikasi (dan sub-propertinya), kemampuan, dan deviceScope yang diatur ke nilai perangkat saat ini atau properti tersebut akan diatur ulang. Disarankan agar api get dipanggil terlebih dahulu sebelum melakukan pembaruan.

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

Parameter

deviceInfo

DeviceDescription

Objek yang harus menyertakan properti deviceId yang nilainya adalah pengidentifikasi perangkat yang valid.

done

HttpResponseCallback<Device>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (dapat null), objek Perangkat yang mewakili identitas perangkat yang diperbarui, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

updateConfiguration(Configuration)

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

Parameter

configuration

Configuration

Mengembalikan

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

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

Parameter

configuration

Configuration

forceUpdate

boolean

Mengembalikan

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

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

Parameter

configuration

Configuration

forceUpdate

boolean

done

HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

Memperbarui konfigurasi di hub IoT

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

Parameter

configuration

Configuration

Objek jenis modul:azure-iothub. Konfigurasi untuk ditambahkan ke hub

done

HttpResponseCallback<any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), isi respons, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

updateDevices(DeviceDescription[], boolean)

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

Parameter

devices

DeviceDescription[]

forceUpdate

boolean

Mengembalikan

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Memperbarui array perangkat. Elemen individual parameter devices harus menyertakan semua properti yang dapat diperbarui. Misalnya, jika memperbarui properti status dari disabled ke enabled, objek juga harus memiliki statusReason, autentikasi (dan sub-propertinya), kemampuan, dan deviceScope yang diatur ke nilai perangkat saat ini atau properti tersebut akan diatur ulang. Disarankan agar api get dipanggil terlebih dahulu sebelum melakukan pembaruan.

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

Parameter

devices

DeviceDescription[]

Array objek yang harus menyertakan properti deviceId yang nilainya adalah pengidentifikasi perangkat yang valid.

forceUpdate

boolean

jika forceUpdate benar maka perangkat akan diperbarui terlepas dari etag. Jika tidak, etag harus cocok.

done

HttpResponseCallback<BulkRegistryOperationResult>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), BulkRegistryOperationResult dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

updateModule(Module)

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

Parameter

module

Module

Mengembalikan

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

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

Parameter

module

Module

forceUpdate

boolean

Mengembalikan

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

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

Parameter

module

Module

forceUpdate

boolean

done

HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

Memperbarui objek modul yang diberikan dalam registri

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

Parameter

module

Module

Objek modul untuk diperbarui.

done

TripleValueCallback<any, any>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (bisa null), isi respons, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

updateModuleTwin(string, string, any, string)

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

Parameter

deviceId

string

moduleId

string

patch

any

etag

string

Mengembalikan

Promise<ResultWithHttpResponse<Twin>>

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

Memperbarui Twin modul tertentu dengan patch yang diberikan.

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

Parameter

deviceId

string

Pengidentifikasi perangkat.

moduleId

string

Pengidentifikasi modul

patch

any

Properti dan tag yang diinginkan untuk menambal modul kembar.

etag

string

Etag terbaru untuk modul ini kembar atau '*' untuk memaksa pembaruan bahkan jika modul kembar telah diperbarui sejak etag diperoleh.

done

HttpResponseCallback<Twin>

Panggilan balik opsional yang akan dipanggil dengan objek Kesalahan atau instans kembar modul.

updateTwin(string, any, string)

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

Parameter

deviceId

string

patch

any

etag

string

Mengembalikan

Promise<ResultWithHttpResponse<Twin>>

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

Memperbarui Device Twin dari perangkat tertentu dengan patch yang diberikan.

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

Parameter

deviceId

string

Pengidentifikasi perangkat.

patch

any

Properti dan tag yang diinginkan untuk menambal perangkat kembar.

etag

string

Etag terbaru untuk perangkat ini kembar atau '*' untuk memaksa pembaruan bahkan jika perangkat kembar telah diperbarui sejak etag diperoleh.

done

HttpResponseCallback<Twin>

Panggilan balik opsional yang akan dipanggil dengan objek Kesalahan atau instans kembar perangkat.