Registry class

Csomag:

azure-iothub

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

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álás hozzáadása egy IoT Hubhoz.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Eszköztömböt ad hozzá.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Adja hozzá a megadott modult a beállításjegyzékhez.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	A megadott konfiguráció alkalmazása egy IoT Hubon lévő eszközre
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 az IoT Hub-példányon futtatható 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 egy blobba tömeges feladatban.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Eszközök exportálása tömeges feladatban lévő blobba konfigurált identitás használatával.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Létrehoz egy beállításjegyzék-objektumot a megadott kapcsolati sztringből.
fromSharedAccessSignature(string)	Létrehoz egy beállításjegyzék-objektumot a megadott közös 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 Hubról
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Az összes konfiguráció lekérése egy IoT Hubon
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 IoT Hubon lévő eszközről
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	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özidentitás-beállításjegyzékben lévő eszközökre vonatkozó statisztikákat.
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>)	Sorolja fel az utolsó importálási/exportálási feladatokat (beleértve az aktívat is, ha van ilyen).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	A megadott azonosítóval rendelkező konfiguráció eltávolítása egy IoT Hubról
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Eszközök tömbjének frissítése.
removeModule(Module, TripleValueCallback<any, any>)	A megadott 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íti 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 status tulajdonságot disabled-ről enabled-ra frissíti, akkor a deviceInfo objektumnak az eszköz aktuális értékeire vagy ezekre a tulajdonságokra beállított ÁllapotReason, hitelesítés (és altulajdonságai), képességei és deviceScope értéke is meg kell jelennie. Javasoljuk, hogy a frissítés előtt először hívja meg 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>)	Eszközök tömbjének frissítése. A devices paraméter egyes elemeinek tartalmazniuk kell az összes frissíthető tulajdonságot. Ha például a status tulajdonságot disabled-ről enabled-ra frissíti, az objektumnak a statusReason állapotúnak, a hitelesítésnek (és annak altulajdonságainak), képességeinek és deviceScope-értékének kell lennie az eszközök aktuális értékeire vagy ezekre a tulajdonságokra. Javasoljuk, hogy a frissítés előtt először 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íti egy adott modul ikerpéldányát a megadott javítással.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Frissíti egy adott eszköz ikereszközét a megadott 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álás hozzáadása egy IoT Hubhoz.

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

Paraméterek

configuration

Configuration

A következő típusú modul objektuma: azure-iothub. A központhoz hozzáadni kívánt konfiguráció

done

HttpResponseCallback<any>

A művelet befejezésekor hívandó opcionális függvény. done a rendszer három argumentummal hívja meg: hibaobjektum (lehet null), a válasz törzse, valamint egy átvitelspecifikus válaszobjektum, 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öztömböt ad hozzá.

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

Paraméterek

devices

DeviceDescription[]

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

done

HttpResponseCallback<BulkRegistryOperationResult>

A művelet befejezésekor hí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ó.

addModule(Module)

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

Paraméterek

module

Module

Válaszok

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Adja hozzá a megadott 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>

A művelet befejezésekor hívandó opcionális függvény. done a rendszer három argumentummal hívja meg: hibaobjektum (lehet null), a válasz törzse, valamint egy átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

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>)

A megadott konfiguráció alkalmazása egy IoT Hubon lévő eszközre

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 alkalmazza a következőre:

content

ConfigurationContent

Az alkalmazandó konfiguráció

done

HttpResponseCallback<any>

A művelet befejezésekor hívandó opcionális függvény. done a rendszer három argumentummal hívja meg: hibaobjektum (lehet null), a válasz törzse, valamint egy átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

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ó állapotinformációkat 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, (egyébként null értékű) és annak a feladatnak a (megszakított) állapota, amelynek az azonosítója argumentumként lett átadva.

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 érvényes eszközazonosítóval rendelkező deviceId tulajdonságot.

done

HttpResponseCallback<Device>

A művelet befejezésekor hívandó opcionális függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), egy eszköz objektum, amely a létrehozott eszközidentitást jelöli, valamint egy, a naplózáshoz vagy hibakereséshez hasznos átvitelspecifikus válaszobjektumtal.

createQuery(string, number)

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

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

Paraméterek

sqlQuery

string

Sql-sztringként írt lekérdezés.

pageSize

number

A kívánt találatok 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 hívandó opcionális függvény. A done három argumentummal lesz meghívva: hibaobjektum (lehet null), always-null argumentum (a többi metódussal való konzisztenciáért), valamint egy naplózáshoz vagy hibakereséshez hasznos átvitelspecifikus válaszobjektum.

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 egy blobba tömeges feladatban.

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

Paraméterek

outputBlobContainerUri

string

Egy tároló URI-ja, amelyben 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 hívható opcionális függvény két argumentummal: hibaobjektum, ha hiba történt, (null egyéb esetben) és az eszközök exportálásának előrehaladásá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 tömeges feladatban lévő blobba konfigurált identitás használatával.

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

Paraméterek

outputBlobContainerUri

string

Egy tároló URI-ja, amelyben 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 hívható opcionális függvény két argumentummal: hibaobjektum, ha hiba történt, (null egyéb esetben) és az eszközök exportálásának előrehaladásának nyomon követésére használható feladat állapota.

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 a megadott kapcsolati sztringből.

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 közös 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 magában foglalja a megfelelő (olvasási és/vagy írási) beállításjegyzék-engedélyeket.

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>

A művelet befejezésekor hívandó opcionális függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), egy eszköz objektum, amely a létrehozott eszközidentitást jelöli, valamint egy, a naplózáshoz vagy hibakereséshez hasznos átvitelspecifikus válaszobjektumtal.

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 Hubról

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, amelyet hibaobjektum vagy modul:azure-iothub használatával hívunk meg. 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 Hubon

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

Paraméterek

done

HttpResponseCallback<Configuration[]>

Az opcionális visszahívás, amely hibaobjektummal vagy modultömbbel lesz meghívva: azure-iothub. 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ó állapotinformációkat 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, (egyébként null értékű), és annak a feladatnak az állapota, amelynek az azonosítója argumentumként lett átadva.

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 IoT Hubon lévő eszközről

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, amelyet hibaobjektummal vagy az azure-iothub modullal hívunk meg. 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[]>)

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 modultömbbel lesz meghívva: azure-iothub. 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özidentitás-beállításjegyzékben lévő eszközökre vonatkozó statisztikákat.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Paraméterek

done

HttpResponseCallback<RegistryStatistics>

Az opcionális visszahívás, amelyet hibaobjektummal vagy az eszközregisztrációs adatbázis statisztikáival hívunk meg.

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

Az importálandó eszközök listáját tartalmazó "devices.txt" nevű blob tárolójának URI-ja.

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 hívható opcionális függvény két argumentummal: hibaobjektum, ha hiba történt, (egyébként null érték), valamint az eszközök importálásának előrehaladásá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

Az importálandó eszközök listáját tartalmazó "devices.txt" nevű blob tárolójának URI-ja.

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 hívható opcionális függvény két argumentummal: hibaobjektum, ha hiba történt, (egyébként null érték), valamint az eszközök importálásának előrehaladásának nyomon követésére használható feladat állapota.

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 hívandó opcionális függvény. A done három argumentummal lesz meghívva: hibaobjektum (lehet null), eszköz- objektumok tömbje, amelyek a felsorolt eszközidentitásokat jelölik, valamint egy, a naplózáshoz vagy hibakereséshez hasznos átvitelspecifikus válaszobjektumtal.

listJobs()

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

Válaszok

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Sorolja fel az utolsó importálási/exportálási feladatokat (beleértve az aktívat is, ha van ilyen).

function listJobs(done?: HttpResponseCallback<any>)

Paraméterek

done

HttpResponseCallback<any>

Az opcionális függvény, amely két argumentummal hívható meg: hibaobjektum, ha hiba történt, (egyébként 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 Hubról

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>

A művelet befejezésekor hívandó opcionális függvény. done a rendszer három argumentummal hívja meg: hibaobjektum (lehet null), a válasz törzse, valamint egy átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

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>)

Eszközök tömbjének frissítése.

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

Paraméterek

devices

DeviceDescription[]

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

forceRemove

boolean

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

done

HttpResponseCallback<BulkRegistryOperationResult>

A művelet befejezésekor hí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>)

A megadott 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>

A művelet befejezésekor hívandó opcionális függvény. done a rendszer három argumentummal hívja meg: hibaobjektum (lehet null), a válasz törzse, valamint egy átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

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íti 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 status tulajdonságot disabled-ről enabled-ra frissíti, akkor a deviceInfo objektumnak az eszköz aktuális értékeire vagy ezekre a tulajdonságokra beállított ÁllapotReason, hitelesítés (és altulajdonságai), képességei és deviceScope értéke is meg kell jelennie. Javasoljuk, hogy a frissítés előtt először hívja meg a get API-t.

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

Paraméterek

deviceInfo

DeviceDescription

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

done

HttpResponseCallback<Device>

A művelet befejezésekor hívandó opcionális függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), egy Eszköz objektum, amely a frissített eszközidentitást jelöli, valamint egy átvitelspecifikus válaszobjektum, amely hasznos naplózáshoz vagy hibakereséshez.

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

A következő típusú modul objektuma: azure-iothub. A központhoz hozzáadni kívánt konfiguráció

done

HttpResponseCallback<any>

A művelet befejezésekor hívandó opcionális függvény. done a rendszer három argumentummal hívja meg: hibaobjektum (lehet null), a válasz törzse, valamint egy átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

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>)

Eszközök tömbjének frissítése. A devices paraméter egyes elemeinek tartalmazniuk kell az összes frissíthető tulajdonságot. Ha például a status tulajdonságot disabled-ről enabled-ra frissíti, az objektumnak a statusReason állapotúnak, a hitelesítésnek (és annak altulajdonságainak), képességeinek és deviceScope-értékének kell lennie az eszközök aktuális értékeire vagy ezekre a tulajdonságokra. Javasoljuk, hogy a frissítés előtt először 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 tulajdonságot, amelynek értéke érvényes eszközazonosító.

forceUpdate

boolean

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

done

HttpResponseCallback<BulkRegistryOperationResult>

A művelet befejezésekor hí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ó.

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>

A művelet befejezésekor hívandó opcionális függvény. done a rendszer három argumentummal hívja meg: hibaobjektum (lehet null), a válasz törzse, valamint egy átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

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íti 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 szükséges 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>

Az opcionális visszahívás, amely hibaobjektummal vagy ikermodul-példánysal 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íti egy adott eszköz ikereszközét a megadott 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

A kívánt tulajdonságok és címkék az ikereszköz javításához.

etag

string

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

done

HttpResponseCallback<Twin>

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