Registry class

Reference

Balíček:: azure-iothub

Třída Registry poskytuje přístup ke službě identit zařízení IoT Hub. Uživatelé sady SDK by měli vytvořit instanci této třídy pomocí jedné z metod továrny: fromConnectionString nebo fromSharedAccessSignature.

Protokol používaný pro operace registru identit zařízení je HTTPS.

Metody

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	Přidejte konfiguraci do centra IoT.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Přidá pole zařízení.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Přidejte daný modul do registru.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	Použití dané konfigurace na zařízení na IoT Hub
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Zrušení úlohy hromadného importu/exportu
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	Vytvoří novou identitu zařízení ve službě IoT Hub.
createQuery(string, number)	Vytvoří dotaz, který lze spustit v instanci IoT Hub a vyhledat informace o zařízeních nebo úlohách.
delete(string)
delete(string, HttpResponseCallback<any>)	Odebere existující identitu zařízení ze služby IoT Hub.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	Export zařízení do objektu blob v hromadné úloze
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Export zařízení do objektu blob v hromadné úloze pomocí nakonfigurované identity
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Vytvoří objekt registru z daného připojovacího řetězce.
fromSharedAccessSignature(string)	Vytvoří objekt registru z daného sdíleného přístupového podpisu.
fromTokenCredential(string, TokenCredential)	Vytvoří objekt registru z dané Azure TokenCredential.
get(string)
get(string, HttpResponseCallback<Device>)	Vyžádá si informace o existující identitě zařízení ve službě IoT Hub.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	Získání jedné konfigurace z IoT Hub
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Získání všech konfigurací na IoT Hub
getJob(string)
getJob(string, Callback<JobStatus>)	Získání stavu úlohy hromadného importu/exportu
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	Získání jednoho modulu ze zařízení na IoT Hub
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	Získání seznamu všech modulů na IoT Hub zařízení
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Získá dvojče modulu modulu se zadaným identifikátorem modulu.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Získá statistiku o zařízeních v registru identit zařízení.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Získá dvojče zařízení zařízení se zadaným identifikátorem zařízení.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Importuje zařízení z objektu blob v hromadné úloze.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Importuje zařízení z objektu blob v hromadné úloze pomocí nakonfigurované identity.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	Vyžádá si informace o prvních 1 000 identitách zařízení ve službě IoT Hub.
listJobs()
listJobs(HttpResponseCallback<any>)	Vypíše poslední úlohy importu a exportu (včetně těch aktivních, pokud jsou k dispozici).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	Odebrání konfigurace se zadaným ID z IoT Hub
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Aktualizace pole zařízení.
removeModule(Module, TripleValueCallback<any, any>)	Odebrání daného modulu z registru
removeModule(string \| Module)
removeModule(string \| Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	Aktualizace existující identitu zařízení ve službě IoT Hub s danými informacemi o zařízení. Parametr `deviceInfo` musí obsahovat všechny vlastnosti, které lze aktualizovat. Pokud například aktualizujete `status` vlastnost z `disabled` na `enabled`, `deviceInfo` objekt by měl mít také statusReason, ověřování (a jeho dílčí vlastnosti), možnosti a deviceScope nastavené na aktuální hodnoty zařízení, nebo se tyto vlastnosti resetují. Před provedením aktualizace se doporučuje nejprve zavolat rozhraní GET API.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	Aktualizace konfigurace v centru IoT
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Aktualizace pole zařízení. Jednotlivé prvky parametru `devices` musí obsahovat všechny vlastnosti, které lze aktualizovat. Pokud například aktualizujete `status` vlastnost z `disabled` na `enabled`, objekt by měl mít také statusReason, ověřování (a jeho dílčí vlastnosti), možnosti a deviceScope nastavené na aktuální hodnoty zařízení, nebo se tyto vlastnosti resetují. Před provedením aktualizace se doporučuje nejprve zavolat rozhraní GET API.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	Aktualizace daného objektu modulu v registru
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Aktualizace dvojče konkrétního modulu s danou opravou.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Aktualizace dvojče zařízení konkrétního zařízení s danou opravou.

Podrobnosti metody

addConfiguration(Configuration)

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

Parametry

configuration: Configuration

Návraty

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

Přidejte konfiguraci do centra IoT.

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

Parametry

configuration: Configuration

Objekt typu module:azure-iothub. Konfigurace, která se má přidat do centra

done: HttpResponseCallback<any>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), text odpovědi a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

addDevices(DeviceDescription[])

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

Parametry

devices: DeviceDescription[]

Návraty

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Přidá pole zařízení.

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

Parametry

devices: DeviceDescription[]

Pole objektů, které musí obsahovat deviceId vlastnost, jejíž hodnota je platným identifikátorem zařízení.

done: HttpResponseCallback<BulkRegistryOperationResult>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), BulkRegistryOperationResult a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

addModule(Module)

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

Parametry

module: Module

Návraty

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Přidejte daný modul do registru.

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

Parametry

module: Module

Objekt modulu, který se má přidat do registru.

done: HttpResponseCallback<any>

applyConfigurationContentOnDevice(string, ConfigurationContent)

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

Parametry

deviceId: string

content: ConfigurationContent

Návraty

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Použití dané konfigurace na zařízení na IoT Hub

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

Parametry

deviceId: string

ID zařízení, na které se má konfigurace použít

content: ConfigurationContent

Konfigurace, která se má použít

done: HttpResponseCallback<any>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), tělo odpovědi a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

cancelJob(string)

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

Parametry

jobId: string

Návraty

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Zrušení úlohy hromadného importu/exportu

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

Parametry

jobId: string

Identifikátor úlohy, pro kterou chce uživatel získat informace o stavu.

done: Callback<JobStatus>

Volitelná funkce, která se má volat se dvěma argumenty: objekt chyby, pokud došlo k chybě, (v opačném případě null) a stav (zrušeno) úlohy, jejíž identifikátor byl předán jako argument.

create(DeviceDescription)

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

Parametry

deviceInfo: DeviceDescription

Návraty

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

Vytvoří novou identitu zařízení ve službě IoT Hub.

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

Parametry

deviceInfo: DeviceDescription

Objekt musí obsahovat deviceId vlastnost s platným identifikátorem zařízení.

done: HttpResponseCallback<Device>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), objekt zařízení představující vytvořenou identitu zařízení a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

createQuery(string, number)

Vytvoří dotaz, který lze spustit v instanci IoT Hub a vyhledat informace o zařízeních nebo úlohách.

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

Parametry

sqlQuery: string

Dotaz zapsaný jako řetězec SQL.

pageSize: number

Požadovaný počet výsledků na stránku (volitelné. výchozí hodnota: 1000, max. 10000).

Návraty

Query

delete(string)

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

Parametry

deviceId: string

Návraty

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

Odebere existující identitu zařízení ze služby IoT Hub.

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

Parametry

deviceId: string

Identifikátor existující identity zařízení.

done: HttpResponseCallback<any>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), argument always-null (kvůli konzistenci s jinými metodami) a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

exportDevicesToBlob(string, boolean)

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

Parametry

outputBlobContainerUri: string

excludeKeys: boolean

Návraty

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Export zařízení do objektu blob v hromadné úloze

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

Parametry

outputBlobContainerUri: string

Identifikátor URI kontejneru, kde se vytvoří objekt blob s názvem devices.txt obsahující seznam zařízení.

excludeKeys: boolean

Logická hodnota označující, jestli mají být klíče zabezpečení vyloučené z exportovaných dat.

done: Callback<JobStatus>

Volitelná funkce, která se má volat při vytvoření úlohy, se dvěma argumenty: objekt chyby v případě chyby (v opačném případě s hodnotou null) a stavem úlohy, který lze použít ke sledování průběhu exportu zařízení.

exportDevicesToBlobByIdentity(string, boolean)

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

Parametry

outputBlobContainerUri: string

excludeKeys: boolean

Návraty

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Export zařízení do objektu blob v hromadné úloze pomocí nakonfigurované identity

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

Parametry

outputBlobContainerUri: string

Identifikátor URI kontejneru, kde se vytvoří objekt blob s názvem devices.txt obsahující seznam zařízení.

excludeKeys: boolean

Logická hodnota označující, jestli mají být klíče zabezpečení vyloučené z exportovaných dat.

done: Callback<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string)

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

Parametry

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

Návraty

Promise<JobStatus>

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

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

Parametry

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

done: Callback<JobStatus>

fromConnectionString(string)

Vytvoří objekt registru z daného připojovacího řetězce.

static function fromConnectionString(value: string): Registry

Parametry

value: string

Připojovací řetězec, který zapouzdřuje příslušná oprávnění registru (čtení nebo zápis).

Návraty

Registry

fromSharedAccessSignature(string)

Vytvoří objekt registru z daného sdíleného přístupového podpisu.

static function fromSharedAccessSignature(value: string): Registry

Parametry

value: string

Sdílený přístupový podpis, který zapouzdřuje příslušná oprávnění registru (čtení nebo zápis).

Návraty

Registry

fromTokenCredential(string, TokenCredential)

Vytvoří objekt registru z dané Azure TokenCredential.

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

Parametry

hostName: string

Název hostitele služby Azure.

tokenCredential: TokenCredential

Přihlašovací údaje tokenu Azure sloužící k ověření ve službě Azure

Návraty

Registry

get(string)

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

Parametry

deviceId: string

Návraty

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

Vyžádá si informace o existující identitě zařízení ve službě IoT Hub.

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

Parametry

deviceId: string

Identifikátor existující identity zařízení.

done: HttpResponseCallback<Device>

getConfiguration(string)

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

Parametry

configurationId: string

Návraty

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

Získání jedné konfigurace z IoT Hub

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

Parametry

configurationId: string

ID konfigurace, kterou chcete načíst

done: HttpResponseCallback<Configuration>

Volitelné zpětné volání, které se bude volat buď s objektem Error, nebo modulem:azure-iothub. Objekt konfigurace s podrobnostmi o konfiguraci.

getConfigurations()

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

Návraty

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Získání všech konfigurací na IoT Hub

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

Parametry

done: HttpResponseCallback<Configuration[]>

Volitelné zpětné volání, které se bude volat s objektem Error nebo polem module:azure-iothub. Objekty konfigurace pro všechny konfigurace.

getJob(string)

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

Parametry

jobId: string

Návraty

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Získání stavu úlohy hromadného importu/exportu

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

Parametry

jobId: string

Identifikátor úlohy, pro kterou chce uživatel získat informace o stavu.

done: Callback<JobStatus>

Volitelná funkce, která se má volat se dvěma argumenty: objekt chyby, pokud došlo k chybě, (v opačném případě null) a stav úlohy, jejíž identifikátor byl předán jako argument.

getModule(string, string)

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

Parametry

deviceId: string

moduleId: string

Návraty

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

Získání jednoho modulu ze zařízení na IoT Hub

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

Parametry

deviceId: string

ID zařízení, které je vlastníkem modulu.

moduleId: string

ID modulu k načtení

done: HttpResponseCallback<Module>

Volitelné zpětné volání, které se bude volat buď s objektem Error, nebo modulem:azure-iothub. Objekt Modulu pro požadovaný modul

getModulesOnDevice(string)

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

Parametry

deviceId: string

Návraty

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

Získání seznamu všech modulů na IoT Hub zařízení

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

Parametry

deviceId: string

ID zařízení, pro které dostáváme moduly

done: HttpResponseCallback<Module[]>

Volitelné zpětné volání, které se bude volat s objektem Error nebo polem module:azure-iothub. Objekty modulů pro všechny moduly.

getModuleTwin(string, string)

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

Parametry

deviceId: string

moduleId: string

Návraty

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Získá dvojče modulu modulu se zadaným identifikátorem modulu.

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

Parametry

deviceId: string

Identifikátor zařízení.

moduleId: string

Identifikátor modulu.

done: HttpResponseCallback<Twin>

Volitelné zpětné volání, které bude volána s error objektu nebo instance dvojčete modulu.

getRegistryStatistics()

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

Návraty

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Získá statistiku o zařízeních v registru identit zařízení.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Parametry

done: HttpResponseCallback<RegistryStatistics>

Volitelné zpětné volání, které se bude volat s objektem Error nebo statistikou registru zařízení.

getTwin(string)

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

Parametry

deviceId: string

Návraty

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Získá dvojče zařízení zařízení se zadaným identifikátorem zařízení.

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

Parametry

deviceId: string

Identifikátor zařízení.

done: HttpResponseCallback<Twin>

Volitelné zpětné volání, které se bude volat s objektem Error nebo instancí dvojčete zařízení.

importDevicesFromBlob(string, string)

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

Parametry

inputBlobContainerUri: string

outputBlobContainerUri: string

Návraty

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

Importuje zařízení z objektu blob v hromadné úloze.

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

Parametry

inputBlobContainerUri: string

Identifikátor URI kontejneru s objektem blob s názvem devices.txt obsahující seznam zařízení, která se mají importovat.

outputBlobContainerUri: string

Identifikátor URI kontejneru, ve kterém se vytvoří objekt blob s protokoly procesu importu.

done: Callback<JobStatus>

importDevicesFromBlobByIdentity(string, string)

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

Parametry

inputBlobContainerUri: string

outputBlobContainerUri: string

Návraty

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Importuje zařízení z objektu blob v hromadné úloze pomocí nakonfigurované identity.

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

Parametry

inputBlobContainerUri: string

Identifikátor URI kontejneru s objektem blob s názvem devices.txt obsahující seznam zařízení, která se mají importovat.

outputBlobContainerUri: string

Identifikátor URI kontejneru, ve kterém se vytvoří objekt blob s protokoly procesu importu.

done: Callback<JobStatus>

importDevicesFromBlobByIdentity(string, string, string)

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

Parametry

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

Návraty

Promise<JobStatus>

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

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

Parametry

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

done: Callback<JobStatus>

list()

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

Návraty

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

Vyžádá si informace o prvních 1 000 identitách zařízení ve službě IoT Hub.

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

Parametry

done: HttpResponseCallback<Device[]>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), pole objektů zařízení představující uvedené identity zařízení a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

listJobs()

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

Návraty

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Vypíše poslední úlohy importu a exportu (včetně těch aktivních, pokud jsou k dispozici).

function listJobs(done?: HttpResponseCallback<any>)

Parametry

done: HttpResponseCallback<any>

Volitelná funkce, která se má volat se dvěma argumenty: objekt error, pokud došlo k chybě, (jinak null) a seznam minulých úloh jako argument.

removeConfiguration(string)

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

Parametry

configurationId: string

Návraty

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

Odebrání konfigurace se zadaným ID z IoT Hub

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

Parametry

configurationId: string

ID konfigurace, která se má odebrat

done: HttpResponseCallback<any>

removeDevices(DeviceDescription[], boolean)

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

Parametry

devices: DeviceDescription[]

forceRemove: boolean

Návraty

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Aktualizace pole zařízení.

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

Parametry

devices: DeviceDescription[]

Pole objektů, které musí obsahovat deviceId vlastnost, jejíž hodnota je platným identifikátorem zařízení.

forceRemove: boolean

Pokud forceRemove má hodnotu true, zařízení se odebere bez ohledu na etag. Jinak se značky eTag musí shodovat.

done: HttpResponseCallback<BulkRegistryOperationResult>

removeModule(Module, TripleValueCallback<any, any>)

Odebrání daného modulu z registru

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

Parametry

module: Module

done: TripleValueCallback<any, any>

removeModule(string | Module)

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

Parametry

moduleOrDeviceId: string | Module

Návraty

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

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

Parametry

moduleOrDeviceId: string | Module

moduleId: string

Návraty

Promise<ResultWithHttpResponse<any>>

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

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

Parametry

deviceId: string

moduleId: string

done: TripleValueCallback<any, any>

update(DeviceDescription)

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

Parametry

deviceInfo: DeviceDescription

Návraty

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

Aktualizace existující identitu zařízení ve službě IoT Hub s danými informacemi o zařízení. Parametr deviceInfo musí obsahovat všechny vlastnosti, které lze aktualizovat. Pokud například aktualizujete status vlastnost z disabled na enabled, deviceInfo objekt by měl mít také statusReason, ověřování (a jeho dílčí vlastnosti), možnosti a deviceScope nastavené na aktuální hodnoty zařízení, nebo se tyto vlastnosti resetují. Před provedením aktualizace se doporučuje nejprve zavolat rozhraní GET API.

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

Parametry

deviceInfo: DeviceDescription

Objekt, který musí obsahovat deviceId vlastnost, jejíž hodnota je platným identifikátorem zařízení.

done: HttpResponseCallback<Device>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), objekt zařízení představující aktualizovanou identitu zařízení a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

updateConfiguration(Configuration)

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

Parametry

configuration: Configuration

Návraty

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

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

Parametry

configuration: Configuration

forceUpdate: boolean

Návraty

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

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

Parametry

configuration: Configuration

forceUpdate: boolean

done: HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

Aktualizace konfigurace v centru IoT

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

Parametry

configuration: Configuration

Objekt typu module:azure-iothub. Konfigurace, která se má přidat do centra

done: HttpResponseCallback<any>

updateDevices(DeviceDescription[], boolean)

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

Parametry

devices: DeviceDescription[]

forceUpdate: boolean

Návraty

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Aktualizace pole zařízení. Jednotlivé prvky parametru devices musí obsahovat všechny vlastnosti, které lze aktualizovat. Pokud například aktualizujete status vlastnost z disabled na enabled, objekt by měl mít také statusReason, ověřování (a jeho dílčí vlastnosti), možnosti a deviceScope nastavené na aktuální hodnoty zařízení, nebo se tyto vlastnosti resetují. Před provedením aktualizace se doporučuje nejprve zavolat rozhraní GET API.

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

Parametry

devices: DeviceDescription[]

Pole objektů, které musí obsahovat deviceId vlastnost, jejíž hodnota je platným identifikátorem zařízení.

forceUpdate: boolean

Pokud forceUpdate je hodnota true, zařízení se aktualizuje bez ohledu na etag. Jinak se značky eTag musí shodovat.

done: HttpResponseCallback<BulkRegistryOperationResult>

updateModule(Module)

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

Parametry

module: Module

Návraty

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

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

Parametry

module: Module

forceUpdate: boolean

Návraty

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

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

Parametry

module: Module

forceUpdate: boolean

done: HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

Aktualizace daného objektu modulu v registru

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

Parametry

module: Module

Objekt modulu, který se má aktualizovat.

done: TripleValueCallback<any, any>

updateModuleTwin(string, string, any, string)

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

Parametry

deviceId: string

moduleId: string

patch: any

etag: string

Návraty

Promise<ResultWithHttpResponse<Twin>>

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

Aktualizace dvojče konkrétního modulu s danou opravou.

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

Parametry

deviceId: string

Identifikátor zařízení.

moduleId: string

Identifikátor modulu

patch: any

Požadované vlastnosti a značky pro opravu dvojčete modulu.

etag: string

Nejnovější značka etag tohoto dvojčete modulu nebo *, která vynutí aktualizaci i v případě, že se dvojče modulu aktualizovalo od získání značky etag.

done: HttpResponseCallback<Twin>

Volitelné zpětné volání, které bude volána s error objektu nebo instance dvojčete modulu.

updateTwin(string, any, string)

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

Parametry

deviceId: string

patch: any

etag: string

Návraty

Promise<ResultWithHttpResponse<Twin>>

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

Aktualizace dvojče zařízení konkrétního zařízení s danou opravou.

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

Parametry

deviceId: string

Identifikátor zařízení.

patch: any

Požadované vlastnosti a značky pro opravu dvojčete zařízení.

etag: string

Nejnovější značka etag pro toto dvojče zařízení nebo *, která vynutí aktualizaci i v případě, že se dvojče zařízení od získání značky etag aktualizovalo.

done: HttpResponseCallback<Twin>

Volitelné zpětné volání, které se bude volat s objektem Error nebo instancí dvojčete zařízení.

Sdílet prostřednictvím

Registry class

Metody

Podrobnosti metody

addConfiguration(Configuration)

Parametry

Návraty

addConfiguration(Configuration, HttpResponseCallback<any>)

Parametry

addDevices(DeviceDescription[])

Parametry

Návraty

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Parametry

addModule(Module)

Parametry

Návraty

addModule(Module, HttpResponseCallback<any>)

Parametry

applyConfigurationContentOnDevice(string, ConfigurationContent)

Parametry

Návraty

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Parametry

cancelJob(string)

Parametry

Návraty

cancelJob(string, Callback<JobStatus>)

Parametry

create(DeviceDescription)

Parametry

Návraty

create(DeviceDescription, HttpResponseCallback<Device>)

Parametry

createQuery(string, number)

Parametry

Návraty

delete(string)

Parametry

Návraty

delete(string, HttpResponseCallback<any>)

Parametry

exportDevicesToBlob(string, boolean)

Parametry

Návraty

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Parametry

exportDevicesToBlobByIdentity(string, boolean)

Parametry

Návraty

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Parametry

exportDevicesToBlobByIdentity(string, boolean, string)

Parametry

Návraty

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

Parametry

fromConnectionString(string)

Parametry

Návraty

fromSharedAccessSignature(string)

Parametry

Návraty

fromTokenCredential(string, TokenCredential)

Parametry

Návraty

get(string)

Parametry

Návraty

get(string, HttpResponseCallback<Device>)

Parametry

getConfiguration(string)

Parametry

Návraty

getConfiguration(string, HttpResponseCallback<Configuration>)

Parametry

getConfigurations()

Návraty

getConfigurations(HttpResponseCallback<Configuration[]>)

Parametry