Registry class

Referencia

Csomag:: azure-iothub

A Beállításjegyzék osztály hozzáférést biztosít az IoT Hub eszközidentitás-szolgáltatáshoz. Az SDK felhasználóinak példányosítaniuk kell ezt az osztályt az egyik gyári módszerrel: fromConnectionString vagy fromSharedAccessSignature.

Az eszközidentitás-beállításjegyzék műveleteihez használt protokoll a HTTPS.

Metódusok

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	Konfiguráció hozzáadása egy IoT Hubhoz.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Eszközök tömbjének hozzáadása.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Adja hozzá az adott modult a beállításjegyzékhez.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	Az adott konfiguráció alkalmazása egy eszközre egy IoT Hub
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Tömeges importálási/exportálási feladat megszakítása.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	Új eszközidentitást hoz létre egy IoT Hubon.
createQuery(string, number)	Létrehoz egy lekérdezést, amely futtatható az IoT Hub-példányon az eszközökkel vagy feladatokkal kapcsolatos információk megkereséséhez.
delete(string)
delete(string, HttpResponseCallback<any>)	Eltávolít egy meglévő eszközidentitást egy IoT Hubról.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	Eszközök exportálása tömeges feladatban lévő blobba.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Eszközök exportálása egy tömeges feladatban lévő blobba konfigurált identitással.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Létrehoz egy beállításjegyzék-objektumot az adott kapcsolati sztring.
fromSharedAccessSignature(string)	Létrehoz egy beállításjegyzék-objektumot a megadott megosztott hozzáférésű jogosultságkódból.
fromTokenCredential(string, TokenCredential)	Létrehoz egy beállításjegyzék-objektumot a megadott Azure TokenCredentialból.
get(string)
get(string, HttpResponseCallback<Device>)	Információt kér egy IoT Hubon található meglévő eszközidentitásról.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	Egyetlen konfiguráció lekérése egy IoT Hub
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Az összes konfiguráció lekérése egy IoT Hub
getJob(string)
getJob(string, Callback<JobStatus>)	Kérje le a tömeges importálási/exportálási feladat állapotát.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	Egyetlen modul lekérése egy eszközről egy IoT Hub
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	Az IoT Hub-eszközön található összes modul listájának lekérése
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Lekéri a modul ikermodulját a megadott modulazonosítóval.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Lekéri az eszközökre vonatkozó statisztikákat az eszközidentitás-beállításjegyzékben.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Lekéri az eszköz ikereszközét a megadott eszközazonosítóval.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Eszközök importálása tömeges feladatban lévő blobból.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Eszközök importálása tömeges feladatban lévő blobból konfigurált identitás használatával.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	Információt kér az IoT Hub első 1000 eszközidentitásáról.
listJobs()
listJobs(HttpResponseCallback<any>)	Listázhatja az utolsó importálási/exportálási feladatokat (ha vannak ilyenek, az aktívat is beleértve).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	A megadott azonosítóval rendelkező konfiguráció eltávolítása egy IoT Hub
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Frissítések egy eszköztömböt.
removeModule(Module, TripleValueCallback<any, any>)	Az adott modul eltávolítása a beállításjegyzékből
removeModule(string \| Module)
removeModule(string \| Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	Frissítések egy meglévő eszközidentitást egy IoT Hubon a megadott eszközinformációkkal. A `deviceInfo` paraméternek tartalmaznia kell az összes frissíthető tulajdonságot. Ha például a tulajdonságot a-ról `statusdisabled` a-ra `enabled`frissíti, az `deviceInfo` objektumnak a Következő állapotúnak, a hitelesítésnek (és annak altulajdonságainak), a képességeknek és a deviceScope értéknek kell lennie az eszközök aktuális értékeire, vagy ezek a tulajdonságok alaphelyzetbe lesznek állítva. Javasoljuk, hogy a frissítés előtt hívja meg először a get API-t.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	Konfiguráció frissítése IoT Hubon
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Frissítések egy eszköztömböt. A paraméter egyes elemeinek tartalmazniuk kell az `devices` összes frissíthető tulajdonságot. Ha például a tulajdonságot a-ról `statusdisabled` értékre `enabled`frissíti, az objektumnak a statusReason állapotával, hitelesítésével (és altulajdonságaival), képességeivel és deviceScope értékével is rendelkeznie kell az eszközök aktuális értékeire, vagy ezek a tulajdonságok alaphelyzetbe állnak. Javasoljuk, hogy a frissítés előtt hívja meg a get API-t.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	A megadott modulobjektum frissítése a beállításjegyzékben
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Frissítések egy adott modul ikerpéldányát a megadott javítással.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Frissítések egy adott eszköz ikereszközét az adott javítással.

Metódus adatai

addConfiguration(Configuration)

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

Paraméterek

configuration: Configuration

Válaszok

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

Konfiguráció hozzáadása egy IoT Hubhoz.

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

Paraméterek

configuration: Configuration

Egy modul típusú objektum: azure-iothub. A központhoz hozzáadandó konfiguráció

done: HttpResponseCallback<any>

A művelet befejezésekor meghívandó nem kötelező függvény. done három argumentummal lesz meghívva: egy Error objektummal (lehet null értékű), a válasz törzsével és egy átvitelspecifikus válaszobjektummal, amely naplózáshoz vagy hibakereséshez használható.

addDevices(DeviceDescription[])

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

Paraméterek

devices: DeviceDescription[]

Válaszok

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Eszközök tömbjének hozzáadása.

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

Paraméterek

devices: DeviceDescription[]

Objektumtömb, amelynek tartalmaznia kell egy deviceId olyan tulajdonságot, amelynek értéke érvényes eszközazonosító.

done: HttpResponseCallback<BulkRegistryOperationResult>

A művelet befejezésekor meghívandó nem kötelező függvény. done három argumentummal lesz meghívva: error objektum (lehet null), BulkRegistryOperationResult és egy átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

addModule(Module)

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

Paraméterek

module: Module

Válaszok

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Adja hozzá az adott modult a beállításjegyzékhez.

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

Paraméterek

module: Module

A beállításjegyzékbe felvenni kívánt modulobjektum.

done: HttpResponseCallback<any>

applyConfigurationContentOnDevice(string, ConfigurationContent)

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

Paraméterek

deviceId: string

content: ConfigurationContent

Válaszok

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Az adott konfiguráció alkalmazása egy eszközre egy IoT Hub

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

Paraméterek

deviceId: string

Annak az eszköznek az azonosítója, amely a konfigurációt a következőre szeretné alkalmazni:

content: ConfigurationContent

Az alkalmazandó konfiguráció

done: HttpResponseCallback<any>

A művelet befejezésekor meghívandó opcionális függvény. done a rendszer három argumentumot fog meghívni: egy Hiba objektumot (lehet null), a válasz törzsét és egy átvitelspecifikus válaszobjektumot, amely hasznos naplózáshoz vagy hibakereséshez.

cancelJob(string)

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

Paraméterek

jobId: string

Válaszok

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Tömeges importálási/exportálási feladat megszakítása.

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

Paraméterek

jobId: string

Annak a feladatnak az azonosítója, amelyhez a felhasználó állapotadatokat szeretne lekérni.

done: Callback<JobStatus>

A nem kötelező függvény két argumentummal hívható meg: hibaobjektum, ha hiba történt, (ellenkező esetben null értékű) és annak a feladatnak a (megszakított) állapota, amelynek az azonosítóját argumentumként adták át.

create(DeviceDescription)

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

Paraméterek

deviceInfo: DeviceDescription

Válaszok

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

Új eszközidentitást hoz létre egy IoT Hubon.

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

Paraméterek

deviceInfo: DeviceDescription

Az objektumnak tartalmaznia kell egy deviceId érvényes eszközazonosítóval rendelkező tulajdonságot.

done: HttpResponseCallback<Device>

A művelet befejezésekor meghívandó opcionális függvény. done a rendszer három argumentumot fog meghívni: egy hibaobjektumot (null értékű lehet), egy eszközobjektumot , amely a létrehozott eszközidentitást képviseli, és egy átvitelspecifikus válaszobjektumot, amely hasznos a naplózáshoz vagy a hibakereséshez.

createQuery(string, number)

Létrehoz egy lekérdezést, amely futtatható az IoT Hub-példányon az eszközökkel vagy feladatokkal kapcsolatos információk megkereséséhez.

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

Paraméterek

sqlQuery: string

Az SQL-sztringként írt lekérdezés.

pageSize: number

Az eredmények kívánt száma oldalanként (nem kötelező. alapértelmezett: 1000, max: 10000).

Válaszok

Query

delete(string)

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

Paraméterek

deviceId: string

Válaszok

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

Eltávolít egy meglévő eszközidentitást egy IoT Hubról.

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

Paraméterek

deviceId: string

Egy meglévő eszközidentitás azonosítója.

done: HttpResponseCallback<any>

A művelet befejezésekor meghívandó opcionális függvény. done három argumentumot fog meghívni: egy Hiba objektumot (lehet null), egy always-null argumentumot (a többi metódussal való konzisztenciáért), és egy átvitelspecifikus válaszobjektumot, amely naplózáshoz vagy hibakereséshez használható.

exportDevicesToBlob(string, boolean)

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

Paraméterek

outputBlobContainerUri: string

excludeKeys: boolean

Válaszok

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Eszközök exportálása tömeges feladatban lévő blobba.

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

Paraméterek

outputBlobContainerUri: string

Egy tároló URI-ja, ahol létrejön egy "devices.txt" nevű blob, amely tartalmazza az eszközök listáját.

excludeKeys: boolean

Logikai érték, amely azt jelzi, hogy a biztonsági kulcsokat ki kell-e zárni az exportált adatokból.

done: Callback<JobStatus>

A feladat létrehozásakor meghívandó nem kötelező függvény két argumentummal: hibaobjektum, ha hiba történt (null értékű egyéb esetben), valamint az eszközök exportálási folyamatának nyomon követésére használható feladat állapota.

exportDevicesToBlobByIdentity(string, boolean)

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

Paraméterek

outputBlobContainerUri: string

excludeKeys: boolean

Válaszok

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Eszközök exportálása egy tömeges feladatban lévő blobba konfigurált identitással.

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

Paraméterek

outputBlobContainerUri: string

Egy tároló URI-ja, ahol létrejön egy "devices.txt" nevű blob, amely tartalmazza az eszközök listáját.

excludeKeys: boolean

Logikai érték, amely azt jelzi, hogy a biztonsági kulcsokat ki kell-e zárni az exportált adatokból.

done: Callback<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string)

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

Paraméterek

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

Válaszok

Promise<JobStatus>

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

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

Paraméterek

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

done: Callback<JobStatus>

fromConnectionString(string)

Létrehoz egy beállításjegyzék-objektumot az adott kapcsolati sztring.

static function fromConnectionString(value: string): Registry

Paraméterek

value: string

A megfelelő (olvasási és/vagy írási) beállításjegyzék-engedélyeket tartalmazó kapcsolati sztring.

Válaszok

Registry

fromSharedAccessSignature(string)

Létrehoz egy beállításjegyzék-objektumot a megadott megosztott hozzáférésű jogosultságkódból.

static function fromSharedAccessSignature(value: string): Registry

Paraméterek

value: string

Közös hozzáférésű jogosultságkód, amely a megfelelő (olvasási és/vagy írási) beállításjegyzék-engedélyeket foglalja magában.

Válaszok

Registry

fromTokenCredential(string, TokenCredential)

Létrehoz egy beállításjegyzék-objektumot a megadott Azure TokenCredentialból.

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

Paraméterek

hostName: string

Az Azure-szolgáltatás állomásneve.

tokenCredential: TokenCredential

Az Azure-szolgáltatással való hitelesítéshez használt Azure TokenCredential

Válaszok

Registry

get(string)

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

Paraméterek

deviceId: string

Válaszok

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

Információt kér egy IoT Hubon található meglévő eszközidentitásról.

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

Paraméterek

deviceId: string

Egy meglévő eszközidentitás azonosítója.

done: HttpResponseCallback<Device>

getConfiguration(string)

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

Paraméterek

configurationId: string

Válaszok

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

Egyetlen konfiguráció lekérése egy IoT Hub

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

Paraméterek

configurationId: string

A lekérni kívánt konfiguráció azonosítója

done: HttpResponseCallback<Configuration>

Az opcionális visszahívás, amely hibaobjektummal vagy modullal lesz meghívva: azure-iothub. Konfigurációs objektum a konfiguráció részleteivel.

getConfigurations()

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

Válaszok

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Az összes konfiguráció lekérése egy IoT Hub

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

Paraméterek

done: HttpResponseCallback<Configuration[]>

Az opcionális visszahívás, amely hibaobjektummal vagy modul:azure-iothub tömbbel lesz meghívva. Konfigurációs objektumok az összes konfigurációhoz.

getJob(string)

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

Paraméterek

jobId: string

Válaszok

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Kérje le a tömeges importálási/exportálási feladat állapotát.

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

Paraméterek

jobId: string

Annak a feladatnak az azonosítója, amelyhez a felhasználó állapotadatokat szeretne lekérni.

done: Callback<JobStatus>

A nem kötelező függvény két argumentummal hívható meg: hibaobjektum, ha hiba történt(máskülönben null értékű), valamint annak a feladatnak az állapota, amelynek az azonosítóját argumentumként adták át.

getModule(string, string)

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

Paraméterek

deviceId: string

moduleId: string

Válaszok

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

Egyetlen modul lekérése egy eszközről egy IoT Hub

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

Paraméterek

deviceId: string

A modult birtokban lévő eszközazonosító.

moduleId: string

Beolvasandó modulazonosító

done: HttpResponseCallback<Module>

Az opcionális visszahívás, amely hibaobjektummal vagy az azure-iothub modullal lesz meghívva. A kért modul modulobjektuma

getModulesOnDevice(string)

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

Paraméterek

deviceId: string

Válaszok

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

Az IoT Hub-eszközön található összes modul listájának lekérése

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

Paraméterek

deviceId: string

Annak az eszköznek az azonosítója, amelyhez modulokat kapunk

done: HttpResponseCallback<Module[]>

Az opcionális visszahívás, amely hibaobjektummal vagy modul:azure-iothub tömbbel lesz meghívva. Modulobjektumok az összes modulhoz.

getModuleTwin(string, string)

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

Paraméterek

deviceId: string

moduleId: string

Válaszok

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Lekéri a modul ikermodulját a megadott modulazonosítóval.

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

Paraméterek

deviceId: string

Az eszköz azonosítója.

moduleId: string

A modul azonosítója.

done: HttpResponseCallback<Twin>

Az opcionális visszahívás, amely hibaobjektummal vagy ikermodul-példánysal lesz meghívva.

getRegistryStatistics()

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

Válaszok

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Lekéri az eszközökre vonatkozó statisztikákat az eszközidentitás-beállításjegyzékben.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Paraméterek

done: HttpResponseCallback<RegistryStatistics>

Az opcionális visszahívás, amely hibaobjektummal vagy az eszközregisztrációs adatbázis statisztikájával lesz meghívva.

getTwin(string)

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

Paraméterek

deviceId: string

Válaszok

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Lekéri az eszköz ikereszközét a megadott eszközazonosítóval.

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

Paraméterek

deviceId: string

Az eszköz azonosítója.

done: HttpResponseCallback<Twin>

Az opcionális visszahívás, amely hibaobjektummal vagy ikereszköz-példánysal lesz meghívva.

importDevicesFromBlob(string, string)

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

Paraméterek

inputBlobContainerUri: string

outputBlobContainerUri: string

Válaszok

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

Eszközök importálása tömeges feladatban lévő blobból.

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

Paraméterek

inputBlobContainerUri: string

A tároló URI-ja egy "devices.txt" nevű blobgal, amely tartalmazza az importálni kívánt eszközök listáját.

outputBlobContainerUri: string

Egy tároló URI-ja, ahol egy blob jön létre az importálási folyamat naplóival.

done: Callback<JobStatus>

A feladat létrehozásakor meghívandó nem kötelező függvény két argumentummal: hibaobjektum, ha hiba történt (máskülönben null értékű), valamint az eszközök importálási folyamatának nyomon követésére használható feladat állapota.

importDevicesFromBlobByIdentity(string, string)

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

Paraméterek

inputBlobContainerUri: string

outputBlobContainerUri: string

Válaszok

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Eszközök importálása tömeges feladatban lévő blobból konfigurált identitás használatával.

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

Paraméterek

inputBlobContainerUri: string

A tároló URI-ja egy "devices.txt" nevű blobgal, amely tartalmazza az importálni kívánt eszközök listáját.

outputBlobContainerUri: string

Egy tároló URI-ja, ahol egy blob jön létre az importálási folyamat naplóival.

done: Callback<JobStatus>

importDevicesFromBlobByIdentity(string, string, string)

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

Paraméterek

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

Válaszok

Promise<JobStatus>

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

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

Paraméterek

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

done: Callback<JobStatus>

list()

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

Válaszok

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

Információt kér az IoT Hub első 1000 eszközidentitásáról.

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

Paraméterek

done: HttpResponseCallback<Device[]>

A művelet befejezésekor meghívandó opcionális függvény. done a rendszer három argumentumot fog meghívni: egy Hibaobjektumot (lehet null), a felsorolt eszközidentitásokat képviselő Eszközobjektumok tömbje, valamint egy naplózáshoz vagy hibakereséshez hasznos, átvitelspecifikus válaszobjektumhoz.

listJobs()

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

Válaszok

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Listázhatja az utolsó importálási/exportálási feladatokat (ha vannak ilyenek, az aktívat is beleértve).

function listJobs(done?: HttpResponseCallback<any>)

Paraméterek

done: HttpResponseCallback<any>

A nem kötelező függvény, amely két argumentummal hívható meg: hibaobjektum, ha hiba történt, (ellenkező esetben null értékű), és a korábbi feladatok listája argumentumként.

removeConfiguration(string)

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

Paraméterek

configurationId: string

Válaszok

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

A megadott azonosítóval rendelkező konfiguráció eltávolítása egy IoT Hub

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

Paraméterek

configurationId: string

Az eltávolítani kívánt konfiguráció azonosítója

done: HttpResponseCallback<any>

removeDevices(DeviceDescription[], boolean)

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

Paraméterek

devices: DeviceDescription[]

forceRemove: boolean

Válaszok

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Frissítések egy eszköztömböt.

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

Paraméterek

devices: DeviceDescription[]

Objektumok tömbje, amelynek tartalmaznia kell egy tulajdonságot deviceId , amelynek értéke érvényes eszközazonosító.

forceRemove: boolean

ha forceRemove igaz, akkor az eszköz az etagtől függetlenül el lesz távolítva. Ellenkező esetben az etageknek egyeznie kell.

done: HttpResponseCallback<BulkRegistryOperationResult>

A művelet befejezésekor meghívandó opcionális függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), Egy BulkRegistryOperationResult és egy átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

removeModule(Module, TripleValueCallback<any, any>)

Az adott modul eltávolítása a beállításjegyzékből

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

Paraméterek

module: Module

done: TripleValueCallback<any, any>

removeModule(string | Module)

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

Paraméterek

moduleOrDeviceId: string | Module

Válaszok

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

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

Paraméterek

moduleOrDeviceId: string | Module

moduleId: string

Válaszok

Promise<ResultWithHttpResponse<any>>

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

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

Paraméterek

deviceId: string

moduleId: string

done: TripleValueCallback<any, any>

update(DeviceDescription)

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

Paraméterek

deviceInfo: DeviceDescription

Válaszok

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

Frissítések egy meglévő eszközidentitást egy IoT Hubon a megadott eszközinformációkkal. A deviceInfo paraméternek tartalmaznia kell az összes frissíthető tulajdonságot. Ha például a tulajdonságot a-ról statusdisabled a-ra enabledfrissíti, az deviceInfo objektumnak a Következő állapotúnak, a hitelesítésnek (és annak altulajdonságainak), a képességeknek és a deviceScope értéknek kell lennie az eszközök aktuális értékeire, vagy ezek a tulajdonságok alaphelyzetbe lesznek állítva. Javasoljuk, hogy a frissítés előtt hívja meg először a get API-t.

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

Paraméterek

deviceInfo: DeviceDescription

Olyan objektum, amelynek tartalmaznia kell egy deviceId olyan tulajdonságot, amelynek értéke érvényes eszközazonosító.

done: HttpResponseCallback<Device>

A művelet befejezésekor meghívandó opcionális függvény. done a rendszer három argumentumot fog meghívni: egy Hibaobjektumot (null értékű lehet), egy frissített eszközidentitást képviselő eszközobjektumot , valamint egy naplózáshoz vagy hibakereséshez hasznos, átvitelspecifikus válaszobjektumot.

updateConfiguration(Configuration)

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

Paraméterek

configuration: Configuration

Válaszok

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

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

Paraméterek

configuration: Configuration

forceUpdate: boolean

Válaszok

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

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

Paraméterek

configuration: Configuration

forceUpdate: boolean

done: HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

Konfiguráció frissítése IoT Hubon

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

Paraméterek

configuration: Configuration

Egy modul típusú objektum: azure-iothub. A központhoz hozzáadandó konfiguráció

done: HttpResponseCallback<any>

updateDevices(DeviceDescription[], boolean)

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

Paraméterek

devices: DeviceDescription[]

forceUpdate: boolean

Válaszok

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Frissítések egy eszköztömböt. A paraméter egyes elemeinek tartalmazniuk kell az devices összes frissíthető tulajdonságot. Ha például a tulajdonságot a-ról statusdisabled értékre enabledfrissíti, az objektumnak a statusReason állapotával, hitelesítésével (és altulajdonságaival), képességeivel és deviceScope értékével is rendelkeznie kell az eszközök aktuális értékeire, vagy ezek a tulajdonságok alaphelyzetbe állnak. Javasoljuk, hogy a frissítés előtt hívja meg a get API-t.

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

Paraméterek

devices: DeviceDescription[]

Objektumtömb, amelynek tartalmaznia kell egy deviceId olyan tulajdonságot, amelynek értéke érvényes eszközazonosító.

forceUpdate: boolean

ha forceUpdate igaz, akkor az eszköz az etagtől függetlenül frissül. Ellenkező esetben az etageknek egyeznie kell.

done: HttpResponseCallback<BulkRegistryOperationResult>

updateModule(Module)

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

Paraméterek

module: Module

Válaszok

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

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

Paraméterek

module: Module

forceUpdate: boolean

Válaszok

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

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

Paraméterek

module: Module

forceUpdate: boolean

done: HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

A megadott modulobjektum frissítése a beállításjegyzékben

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

Paraméterek

module: Module

Frissítendő modulobjektum.

done: TripleValueCallback<any, any>

updateModuleTwin(string, string, any, string)

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

Paraméterek

deviceId: string

moduleId: string

patch: any

etag: string

Válaszok

Promise<ResultWithHttpResponse<Twin>>

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

Frissítések egy adott modul ikerpéldányát a megadott javítással.

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

Paraméterek

deviceId: string

Az eszköz azonosítója.

moduleId: string

A modul azonosítója

patch: any

A modul ikerpéldányának javításához használni kívánt tulajdonságok és címkék.

etag: string

A modul ikerpéldányának vagy a *-nak a legújabb etagje akkor is kényszeríti a frissítést, ha a modul ikerpéldánya az etag beszerzése óta frissült.

done: HttpResponseCallback<Twin>

A nem kötelező visszahívás, amely hibaobjektummal vagy ikermodul-példánnyal lesz meghívva.

updateTwin(string, any, string)

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

Paraméterek

deviceId: string

patch: any

etag: string

Válaszok

Promise<ResultWithHttpResponse<Twin>>

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

Frissítések egy adott eszköz ikereszközét az adott javítással.

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

Paraméterek

deviceId: string

Az eszköz azonosítója.

patch: any

Az ikereszköz javításához használni kívánt tulajdonságok és címkék.

etag: string

Az ikereszköz legújabb etagje vagy a "*" akkor is kényszeríti a frissítést, ha az ikereszköz az etag beszerzése óta frissült.

done: HttpResponseCallback<Twin>

Az opcionális visszahívás, amely hibaobjektummal vagy ikereszköz-példánnyal lesz meghívva.

Megosztás a következőn keresztül:

Registry class

Metódusok

Metódus adatai

addConfiguration(Configuration)

Paraméterek

Válaszok

addConfiguration(Configuration, HttpResponseCallback<any>)

Paraméterek

addDevices(DeviceDescription[])

Paraméterek

Válaszok

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Paraméterek

addModule(Module)

Paraméterek

Válaszok

addModule(Module, HttpResponseCallback<any>)

Paraméterek

applyConfigurationContentOnDevice(string, ConfigurationContent)

Paraméterek

Válaszok

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Paraméterek

cancelJob(string)

Paraméterek

Válaszok

cancelJob(string, Callback<JobStatus>)

Paraméterek

create(DeviceDescription)

Paraméterek

Válaszok

create(DeviceDescription, HttpResponseCallback<Device>)

Paraméterek

createQuery(string, number)

Paraméterek

Válaszok

delete(string)

Paraméterek

Válaszok

delete(string, HttpResponseCallback<any>)

Paraméterek

exportDevicesToBlob(string, boolean)

Paraméterek

Válaszok

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Paraméterek

exportDevicesToBlobByIdentity(string, boolean)

Paraméterek

Válaszok

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Paraméterek

exportDevicesToBlobByIdentity(string, boolean, string)

Paraméterek

Válaszok

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

Paraméterek

fromConnectionString(string)

Paraméterek

Válaszok

fromSharedAccessSignature(string)

Paraméterek

Válaszok

fromTokenCredential(string, TokenCredential)

Paraméterek

Válaszok

get(string)

Paraméterek

Válaszok

get(string, HttpResponseCallback<Device>)

Paraméterek

getConfiguration(string)

Paraméterek

Válaszok

getConfiguration(string, HttpResponseCallback<Configuration>)

Paraméterek

getConfigurations()

Válaszok

getConfigurations(HttpResponseCallback<Configuration[]>)

Paraméterek