Registry class

Pacchetto:

azure-iothub

La classe Registro di sistema fornisce l'accesso al servizio di identità del dispositivo hub IoT. Gli utenti dell'SDK devono creare un'istanza di questa classe con uno dei metodi factory: fromConnectionString o fromSharedAccessSignature.

Il protocollo usato per le operazioni del Registro di sistema delle identità del dispositivo è HTTPS.

Metodi

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	Aggiungere una configurazione a un hub IoT.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Aggiunge una matrice di dispositivi.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Aggiungere il modulo specificato al Registro di sistema.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	Applicare la configurazione specificata a un dispositivo in un hub IoT
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Annullare un processo di importazione/esportazione bulk.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	Crea una nuova identità del dispositivo in un hub IoT.
createQuery(string, number)	Crea una query che può essere eseguita nell'istanza di hub IoT per trovare informazioni sui dispositivi o sui processi.
delete(string)
delete(string, HttpResponseCallback<any>)	Rimuove un'identità del dispositivo esistente da un hub IoT.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	Esportare i dispositivi in un BLOB in un processo bulk.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Esportare i dispositivi in un BLOB in un processo bulk usando un'identità configurata.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Costruisce un oggetto Registro di sistema dalla stringa di connessione specificata.
fromSharedAccessSignature(string)	Costruisce un oggetto Registro di sistema dalla firma di accesso condiviso specificata.
fromTokenCredential(string, TokenCredential)	Costruisce un oggetto Registro di sistema dall'oggetto Azure TokenCredential specificato.
get(string)
get(string, HttpResponseCallback<Device>)	Richiede informazioni su un'identità del dispositivo esistente in un hub IoT.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	Ottenere una singola configurazione da un hub IoT
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Ottenere tutte le configurazioni in un hub IoT
getJob(string)
getJob(string, Callback<JobStatus>)	Ottenere lo stato di un processo di importazione/esportazione bulk.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	Ottenere un singolo modulo da un dispositivo in un hub IoT
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	Ottenere un elenco di tutti i moduli in un dispositivo hub IoT
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Ottiene il modulo Gemello del modulo con l'identificatore del modulo specificato.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Ottiene le statistiche sui dispositivi nel Registro identità del dispositivo.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Ottiene il dispositivo Gemello del dispositivo con l'identificatore del dispositivo specificato.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Importa i dispositivi da un BLOB in blocco.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Importa i dispositivi da un BLOB in blocco usando un'identità configurata.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	Richiede informazioni sulle prime 1000 identità dei dispositivi in un hub IoT.
listJobs()
listJobs(HttpResponseCallback<any>)	Elencare gli ultimi processi di importazione/esportazione (incluso quello attivo, se presente).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	Rimuovere una configurazione con l'ID specificato da un hub IoT
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Aggiornamenti una matrice di dispositivi.
removeModule(Module, TripleValueCallback<any, any>)	Rimuovere il modulo specificato dal Registro di sistema
removeModule(string | Module)
removeModule(string | Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	Aggiornamenti un'identità del dispositivo esistente in un hub IoT con le informazioni sul dispositivo specificate. Il deviceInfo parametro deve includere tutte le proprietà aggiornabili. Ad esempio, se l'aggiornamento della status proprietà da disabled a enabled, l'oggetto deviceInfo deve avere anche lo statoReason, l'autenticazione (e le relative proprietà secondarie), le funzionalità e deviceScope impostate sui valori correnti dei dispositivi o tali proprietà verranno reimpostate. È consigliabile che l'API get venga chiamata prima di eseguire un aggiornamento.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	Aggiornare una configurazione in un hub IoT
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Aggiornamenti una matrice di dispositivi. I singoli elementi del devices parametro devono includere tutte le proprietà aggiornabili. Ad esempio, se l'aggiornamento della status proprietà da disabled a enabled, l'oggetto deve avere anche lo statoReason, l'autenticazione (e le relative proprietà secondarie), le funzionalità e deviceScope impostate sui valori correnti dei dispositivi o tali proprietà verranno reimpostate. È consigliabile che l'API get venga chiamata prima di eseguire un aggiornamento.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	Aggiornare l'oggetto modulo specificato nel Registro di sistema
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Aggiornamenti gemello di un modulo specifico con la patch specificata.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Aggiornamenti dispositivo gemello di un dispositivo specifico con la patch specificata.

Dettagli metodo

addConfiguration(Configuration)

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

Parametri

configuration

Configuration

Restituisce

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

Aggiungere una configurazione a un hub IoT.

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

Parametri

configuration

Configuration

Oggetto di tipo module:azure-iothub. Configurazione da aggiungere all'hub

done

HttpResponseCallback<any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), il corpo della risposta e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

addDevices(DeviceDescription[])

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

Parametri

devices

DeviceDescription[]

Restituisce

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Aggiunge una matrice di dispositivi.

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

Parametri

devices

DeviceDescription[]

Matrice di oggetti che devono includere una deviceId proprietà il cui valore è un identificatore di dispositivo valido.

done

HttpResponseCallback<BulkRegistryOperationResult>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere null), un oggetto BulkRegistryOperationResult e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

addModule(Module)

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

Parametri

module

Module

Restituisce

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Aggiungere il modulo specificato al Registro di sistema.

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

Parametri

module

Module

Oggetto Module da aggiungere al Registro di sistema.

done

HttpResponseCallback<any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), il corpo della risposta e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

applyConfigurationContentOnDevice(string, ConfigurationContent)

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

Parametri

deviceId

string

content

ConfigurationContent

Restituisce

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Applicare la configurazione specificata a un dispositivo in un hub IoT

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

Parametri

deviceId

string

ID del dispositivo da applicare alla configurazione

content

ConfigurationContent

Configurazione da applicare

done

HttpResponseCallback<any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), il corpo della risposta e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

cancelJob(string)

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

Parametri

jobId

string

Restituisce

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Annullare un processo di importazione/esportazione bulk.

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

Parametri

jobId

string

Identificatore del processo per il quale l'utente vuole ottenere informazioni sullo stato.

done

Callback<JobStatus>

Funzione facoltativa da chiamare con due argomenti: un oggetto errore se si è verificato un errore, (null in caso contrario) e lo stato (annullato) del processo il cui identificatore è stato passato come argomento.

create(DeviceDescription)

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

Parametri

deviceInfo

DeviceDescription

Restituisce

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

Crea una nuova identità del dispositivo in un hub IoT.

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

Parametri

deviceInfo

DeviceDescription

L'oggetto deve includere una proprietà con un deviceId identificatore di dispositivo valido.

done

HttpResponseCallback<Device>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), un oggetto Device che rappresenta l'identità del dispositivo creata e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

createQuery(string, number)

Crea una query che può essere eseguita nell'istanza di hub IoT per trovare informazioni sui dispositivi o sui processi.

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

Parametri

sqlQuery

string

Query scritta come stringa SQL.

pageSize

number

Numero desiderato di risultati per pagina (facoltativo. impostazione predefinita: 1000, max: 10000).

Restituisce

Query

delete(string)

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

Parametri

deviceId

string

Restituisce

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

Rimuove un'identità del dispositivo esistente da un hub IoT.

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

Parametri

deviceId

string

Identificatore di un'identità del dispositivo esistente.

done

HttpResponseCallback<any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), un argomento always-null (per coerenza con gli altri metodi) e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

exportDevicesToBlob(string, boolean)

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

Parametri

outputBlobContainerUri

string

excludeKeys

boolean

Restituisce

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Esportare i dispositivi in un BLOB in un processo bulk.

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

Parametri

outputBlobContainerUri

string

L'URI a un contenitore in cui verrà creato un BLOB denominato 'devices.txt' contenente l'elenco di dispositivi.

excludeKeys

boolean

Boolean che indica se le chiavi di sicurezza devono essere escluse dai dati esportati.

done

Callback<JobStatus>

Funzione facoltativa da chiamare quando il processo è stato creato, con due argomenti: un oggetto errore se si è verificato un errore, (null in caso contrario) e lo stato del processo che può essere usato per tenere traccia dello stato di avanzamento dell'esportazione dei dispositivi.

exportDevicesToBlobByIdentity(string, boolean)

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

Parametri

outputBlobContainerUri

string

excludeKeys

boolean

Restituisce

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Esportare i dispositivi in un BLOB in un processo bulk usando un'identità configurata.

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

Parametri

outputBlobContainerUri

string

L'URI a un contenitore in cui verrà creato un BLOB denominato 'devices.txt' contenente l'elenco di dispositivi.

excludeKeys

boolean

Boolean che indica se le chiavi di sicurezza devono essere escluse dai dati esportati.

done

Callback<JobStatus>

Funzione facoltativa da chiamare quando il processo è stato creato, con due argomenti: un oggetto errore se si è verificato un errore, (null in caso contrario) e lo stato del processo che può essere usato per tenere traccia dello stato di avanzamento dell'esportazione dei dispositivi.

exportDevicesToBlobByIdentity(string, boolean, string)

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

Parametri

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

Restituisce

Promise<JobStatus>

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

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

Parametri

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

done

Callback<JobStatus>

fromConnectionString(string)

Costruisce un oggetto Registro di sistema dalla stringa di connessione specificata.

static function fromConnectionString(value: string): Registry

Parametri

value

string

Stringa di connessione che incapsula le autorizzazioni appropriate (lettura e/o scrittura).

Restituisce

Registry

fromSharedAccessSignature(string)

Costruisce un oggetto Registro di sistema dalla firma di accesso condiviso specificata.

static function fromSharedAccessSignature(value: string): Registry

Parametri

value

string

Firma di accesso condiviso che incapsula le autorizzazioni appropriate (lettura e/o scrittura) del Registro di sistema.

Restituisce

Registry

fromTokenCredential(string, TokenCredential)

Costruisce un oggetto Registro di sistema dall'oggetto Azure TokenCredential specificato.

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

Parametri

hostName

string

Nome host del servizio di Azure.

tokenCredential

TokenCredential

Un token di AzureCredential usato per l'autenticazione con il servizio di Azure

Restituisce

Registry

get(string)

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

Parametri

deviceId

string

Restituisce

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

Richiede informazioni su un'identità del dispositivo esistente in un hub IoT.

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

Parametri

deviceId

string

Identificatore di un'identità del dispositivo esistente.

done

HttpResponseCallback<Device>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), un oggetto Device che rappresenta l'identità del dispositivo creata e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

getConfiguration(string)

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

Parametri

configurationId

string

Restituisce

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

Ottenere una singola configurazione da un hub IoT

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

Parametri

configurationId

string

ID della configurazione con cui recuperare

done

HttpResponseCallback<Configuration>

Callback facoltativo che verrà chiamato con un oggetto Error o un modulo:azure-iothub. Oggetto di configurazione con i dettagli della configurazione.

getConfigurations()

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

Restituisce

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Ottenere tutte le configurazioni in un hub IoT

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

Parametri

done

HttpResponseCallback<Configuration[]>

Callback facoltativo che verrà chiamato con un oggetto Error o una matrice di module:azure-iothub. Oggetti di configurazione per tutte le configurazioni.

getJob(string)

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

Parametri

jobId

string

Restituisce

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Ottenere lo stato di un processo di importazione/esportazione bulk.

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

Parametri

jobId

string

Identificatore del processo per il quale l'utente vuole ottenere informazioni sullo stato.

done

Callback<JobStatus>

Funzione facoltativa da chiamare con due argomenti: un oggetto errore se si è verificato un errore, (null in caso contrario) e lo stato del processo il cui identificatore è stato passato come argomento.

getModule(string, string)

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

Parametri

deviceId

string

moduleId

string

Restituisce

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

Ottenere un singolo modulo da un dispositivo in un hub IoT

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

Parametri

deviceId

string

ID dispositivo proprietario del modulo.

moduleId

string

ID modulo da recuperare

done

HttpResponseCallback<Module>

Callback facoltativo che verrà chiamato con un oggetto Error o il modulo:azure-iothub. Oggetto Module per il modulo richiesto

getModulesOnDevice(string)

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

Parametri

deviceId

string

Restituisce

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

Ottenere un elenco di tutti i moduli in un dispositivo hub IoT

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

Parametri

deviceId

string

ID del dispositivo per cui vengono recuperati i moduli

done

HttpResponseCallback<Module[]>

Callback facoltativo che verrà chiamato con un oggetto Error o una matrice di module:azure-iothub. Oggetti modulo per tutti i moduli.

getModuleTwin(string, string)

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

Parametri

deviceId

string

moduleId

string

Restituisce

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Ottiene il modulo Gemello del modulo con l'identificatore del modulo specificato.

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

Parametri

deviceId

string

Identificatore del dispositivo.

moduleId

string

Identificatore del modulo.

done

HttpResponseCallback<Twin>

Callback facoltativo che verrà chiamato con un oggetto Error o l'istanza del modulo gemello.

getRegistryStatistics()

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

Restituisce

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Ottiene le statistiche sui dispositivi nel Registro identità del dispositivo.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Parametri

done

HttpResponseCallback<RegistryStatistics>

Callback facoltativo che verrà chiamato con un oggetto Error o le statistiche del Registro di sistema del dispositivo.

getTwin(string)

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

Parametri

deviceId

string

Restituisce

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Ottiene il dispositivo Gemello del dispositivo con l'identificatore del dispositivo specificato.

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

Parametri

deviceId

string

Identificatore del dispositivo.

done

HttpResponseCallback<Twin>

Callback facoltativo che verrà chiamato con un oggetto Error o l'istanza del dispositivo gemello.

importDevicesFromBlob(string, string)

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

Parametri

inputBlobContainerUri

string

outputBlobContainerUri

string

Restituisce

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

Importa i dispositivi da un BLOB in blocco.

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

Parametri

inputBlobContainerUri

string

URI a un contenitore con un BLOB denominato 'devices.txt' contenente un elenco di dispositivi da importare.

outputBlobContainerUri

string

URI a un contenitore in cui verrà creato un BLOB con i log del processo di importazione.

done

Callback<JobStatus>

Funzione facoltativa da chiamare quando il processo è stato creato, con due argomenti: un oggetto errore se si è verificato un errore, (null in caso contrario) e lo stato del processo che può essere usato per tenere traccia dello stato di avanzamento dell'importazione dei dispositivi.

importDevicesFromBlobByIdentity(string, string)

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

Parametri

inputBlobContainerUri

string

outputBlobContainerUri

string

Restituisce

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Importa i dispositivi da un BLOB in blocco usando un'identità configurata.

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

Parametri

inputBlobContainerUri

string

URI a un contenitore con un BLOB denominato 'devices.txt' contenente un elenco di dispositivi da importare.

outputBlobContainerUri

string

URI a un contenitore in cui verrà creato un BLOB con i log del processo di importazione.

done

Callback<JobStatus>

Funzione facoltativa da chiamare quando il processo è stato creato, con due argomenti: un oggetto errore se si è verificato un errore, (null in caso contrario) e lo stato del processo che può essere usato per tenere traccia dello stato di avanzamento dell'importazione dei dispositivi.

importDevicesFromBlobByIdentity(string, string, string)

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

Parametri

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

Restituisce

Promise<JobStatus>

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

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

Parametri

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

done

Callback<JobStatus>

list()

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

Restituisce

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

Richiede informazioni sulle prime 1000 identità dei dispositivi in un hub IoT.

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

Parametri

done

HttpResponseCallback<Device[]>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere null), una matrice di oggetti Device che rappresentano le identità del dispositivo elencate e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

listJobs()

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

Restituisce

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Elencare gli ultimi processi di importazione/esportazione (incluso quello attivo, se presente).

function listJobs(done?: HttpResponseCallback<any>)

Parametri

done

HttpResponseCallback<any>

Funzione facoltativa da chiamare con due argomenti: un oggetto errore se si è verificato un errore, (null in caso contrario) e l'elenco dei processi precedenti come argomento.

removeConfiguration(string)

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

Parametri

configurationId

string

Restituisce

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

Rimuovere una configurazione con l'ID specificato da un hub IoT

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

Parametri

configurationId

string

ID della configurazione da rimuovere

done

HttpResponseCallback<any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), il corpo della risposta e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

removeDevices(DeviceDescription[], boolean)

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

Parametri

devices

DeviceDescription[]

forceRemove

boolean

Restituisce

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Aggiornamenti una matrice di dispositivi.

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

Parametri

devices

DeviceDescription[]

Matrice di oggetti che devono includere una deviceId proprietà il cui valore è un identificatore di dispositivo valido.

forceRemove

boolean

se forceRemove è true, il dispositivo verrà rimosso indipendentemente da un etag. In caso contrario, gli etag devono corrispondere.

done

HttpResponseCallback<BulkRegistryOperationResult>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere null), un oggetto BulkRegistryOperationResult e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

removeModule(Module, TripleValueCallback<any, any>)

Rimuovere il modulo specificato dal Registro di sistema

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

Parametri

module

Module

done

TripleValueCallback<any, any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), il corpo della risposta e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

removeModule(string | Module)

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

Parametri

moduleOrDeviceId

string | Module

Restituisce

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

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

Parametri

moduleOrDeviceId

string | Module

moduleId

string

Restituisce

Promise<ResultWithHttpResponse<any>>

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

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

Parametri

deviceId

string

moduleId

string

done

TripleValueCallback<any, any>

update(DeviceDescription)

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

Parametri

deviceInfo

DeviceDescription

Restituisce

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

Aggiornamenti un'identità del dispositivo esistente in un hub IoT con le informazioni sul dispositivo specificate. Il deviceInfo parametro deve includere tutte le proprietà aggiornabili. Ad esempio, se l'aggiornamento della status proprietà da disabled a enabled, l'oggetto deviceInfo deve avere anche lo statoReason, l'autenticazione (e le relative proprietà secondarie), le funzionalità e deviceScope impostate sui valori correnti dei dispositivi o tali proprietà verranno reimpostate. È consigliabile che l'API get venga chiamata prima di eseguire un aggiornamento.

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

Parametri

deviceInfo

DeviceDescription

Oggetto che deve includere una deviceId proprietà il cui valore è un identificatore di dispositivo valido.

done

HttpResponseCallback<Device>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), un oggetto Device che rappresenta l'identità del dispositivo aggiornata e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

updateConfiguration(Configuration)

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

Parametri

configuration

Configuration

Restituisce

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

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

Parametri

configuration

Configuration

forceUpdate

boolean

Restituisce

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

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

Parametri

configuration

Configuration

forceUpdate

boolean

done

HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

Aggiornare una configurazione in un hub IoT

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

Parametri

configuration

Configuration

Oggetto di tipo module:azure-iothub. Configurazione da aggiungere all'hub

done

HttpResponseCallback<any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), il corpo della risposta e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

updateDevices(DeviceDescription[], boolean)

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

Parametri

devices

DeviceDescription[]

forceUpdate

boolean

Restituisce

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Aggiornamenti una matrice di dispositivi. I singoli elementi del devices parametro devono includere tutte le proprietà aggiornabili. Ad esempio, se l'aggiornamento della status proprietà da disabled a enabled, l'oggetto deve avere anche lo statoReason, l'autenticazione (e le relative proprietà secondarie), le funzionalità e deviceScope impostate sui valori correnti dei dispositivi o tali proprietà verranno reimpostate. È consigliabile che l'API get venga chiamata prima di eseguire un aggiornamento.

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

Parametri

devices

DeviceDescription[]

Matrice di oggetti che devono includere una deviceId proprietà il cui valore è un identificatore di dispositivo valido.

forceUpdate

boolean

se forceUpdate è true, il dispositivo verrà aggiornato indipendentemente da un etag. In caso contrario, gli etag devono corrispondere.

done

HttpResponseCallback<BulkRegistryOperationResult>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere null), un oggetto BulkRegistryOperationResult e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

updateModule(Module)

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

Parametri

module

Module

Restituisce

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

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

Parametri

module

Module

forceUpdate

boolean

Restituisce

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

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

Parametri

module

Module

forceUpdate

boolean

done

HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

Aggiornare l'oggetto modulo specificato nel Registro di sistema

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

Parametri

module

Module

Oggetto Module da aggiornare.

done

TripleValueCallback<any, any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), il corpo della risposta e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

updateModuleTwin(string, string, any, string)

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

Parametri

deviceId

string

moduleId

string

patch

any

etag

string

Restituisce

Promise<ResultWithHttpResponse<Twin>>

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

Aggiornamenti gemello di un modulo specifico con la patch specificata.

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

Parametri

deviceId

string

Identificatore del dispositivo.

moduleId

string

Identificatore del modulo

patch

any

Le proprietà e i tag desiderati per applicare patch al modulo gemello con.

etag

string

L'etag più recente per questo modulo gemello o '*' per forzare un aggiornamento anche se il modulo gemello è stato aggiornato dopo aver ottenuto l'etag.

done

HttpResponseCallback<Twin>

Callback facoltativo che verrà chiamato con un oggetto Error o l'istanza del modulo gemello.

updateTwin(string, any, string)

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

Parametri

deviceId

string

patch

any

etag

string

Restituisce

Promise<ResultWithHttpResponse<Twin>>

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

Aggiornamenti dispositivo gemello di un dispositivo specifico con la patch specificata.

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

Parametri

deviceId

string

Identificatore del dispositivo.

patch

any

Le proprietà e i tag desiderati per applicare patch al dispositivo gemello con.

etag

string

L'ultimo etag per questo dispositivo gemello o '*' per forzare un aggiornamento anche se il dispositivo gemello è stato aggiornato dopo che è stato ottenuto l'etag.

done

HttpResponseCallback<Twin>

Callback facoltativo che verrà chiamato con un oggetto Error o l'istanza del dispositivo gemello.