Registry class

Referencia

Paquete:: azure-iothub

La clase Registry proporciona acceso al servicio de identidad de dispositivo IoT Hub. Los usuarios del SDK deben crear instancias de esta clase con uno de los métodos de fábrica: fromConnectionString o fromSharedAccessSignature.

El protocolo utilizado para las operaciones del registro de identidades de dispositivo es HTTPS.

Métodos

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	Agregue una configuración a un centro de IoT.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Agrega una matriz de dispositivos.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Agregue el módulo especificado al Registro.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	Aplicar la configuración especificada a un dispositivo en un IoT Hub
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Cancelar un trabajo de importación o exportación masiva.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	Crea una nueva identidad de dispositivo en un centro de IoT.
createQuery(string, number)	Crea una consulta que se puede ejecutar en la instancia de IoT Hub para buscar información sobre dispositivos o trabajos.
delete(string)
delete(string, HttpResponseCallback<any>)	Quita una identidad de dispositivo existente de un centro de IoT.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	Exportar dispositivos a un blob en un trabajo masivo.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Exportar dispositivos a un blob en un trabajo masivo mediante una identidad configurada.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Construye un objeto Registry a partir de la cadena de conexión especificada.
fromSharedAccessSignature(string)	Construye un objeto Registry a partir de la firma de acceso compartido especificada.
fromTokenCredential(string, TokenCredential)	Construye un objeto Registry a partir del token de Azure EspecificadoCredential.
get(string)
get(string, HttpResponseCallback<Device>)	Solicita información sobre una identidad de dispositivo existente en un centro de IoT.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	Obtener una única configuración de un IoT Hub
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Obtener todas las configuraciones de un IoT Hub
getJob(string)
getJob(string, Callback<JobStatus>)	Obtenga el estado de un trabajo de importación o exportación masiva.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	Obtener un único módulo de un dispositivo en una IoT Hub
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	Obtener una lista de todos los módulos de un dispositivo IoT Hub
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Obtiene el módulo gemelo del módulo con el identificador de módulo especificado.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Obtiene estadísticas sobre los dispositivos del registro de identidad del dispositivo.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Obtiene el dispositivo gemelo del dispositivo con el identificador de dispositivo especificado.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Importa dispositivos desde un blob en un trabajo masivo.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Importa dispositivos desde un blob en un trabajo masivo mediante una identidad configurada.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	Solicita información sobre las primeras 1000 identidades de dispositivo en un centro de IoT.
listJobs()
listJobs(HttpResponseCallback<any>)	Enumere los últimos trabajos de importación y exportación (incluido el activo, si existe).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	Quitar una configuración con el identificador especificado de un IoT Hub
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Novedades una matriz de dispositivos.
removeModule(Module, TripleValueCallback<any, any>)	Eliminación del módulo especificado del registro
removeModule(string \| Module)
removeModule(string \| Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	Novedades una identidad de dispositivo existente en un centro de IoT con la información del dispositivo especificada. El `deviceInfo` parámetro debe incluir todas las propiedades que son actualizables. Por ejemplo, si actualiza la `status` propiedad de `disabled` a `enabled`, el `deviceInfo` objeto también debe tener statusReason, autenticación (y sus subpropiedades), funcionalidades y deviceScope establecidos en los valores actuales de los dispositivos o se restablecerán esas propiedades. Se recomienda llamar primero a la API get antes de realizar una actualización.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	Actualización de una configuración en un centro de IoT
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Novedades una matriz de dispositivos. Los elementos individuales del `devices` parámetro deben incluir todas las propiedades que son actualizables. Por ejemplo, si actualiza la `status` propiedad de `disabled` a `enabled`, el objeto también debe tener statusReason, autenticación (y sus subpropiedades), funcionalidades y deviceScope establecidos en los valores actuales de los dispositivos o esas propiedades se restablecerán. Se recomienda llamar primero a la API get antes de realizar una actualización.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	Actualización del objeto de módulo especificado en el Registro
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Novedades el gemelo de un módulo específico con la revisión especificada.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Novedades el dispositivo gemelo de un dispositivo específico con la revisión especificada.

Detalles del método

addConfiguration(Configuration)

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

Parámetros

configuration: Configuration

Devoluciones

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

Agregue una configuración a un centro de IoT.

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

Parámetros

configuration: Configuration

Objeto de tipo module:azure-iothub. Configuración para agregar al centro

done: HttpResponseCallback<any>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser NULL), el cuerpo de la respuesta y un objeto de respuesta específico del transporte útil para el registro o la depuración.

addDevices(DeviceDescription[])

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

Parámetros

devices: DeviceDescription[]

Devoluciones

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Agrega una matriz de dispositivos.

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

Parámetros

devices: DeviceDescription[]

Matriz de objetos que deben incluir una deviceId propiedad cuyo valor es un identificador de dispositivo válido.

done: HttpResponseCallback<BulkRegistryOperationResult>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser NULL), bulkRegistryOperationResult y un objeto de respuesta específico del transporte útil para el registro o la depuración.

addModule(Module)

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

Parámetros

module: Module

Devoluciones

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Agregue el módulo especificado al Registro.

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

Parámetros

module: Module

Objeto module que se va a agregar al Registro.

done: HttpResponseCallback<any>

applyConfigurationContentOnDevice(string, ConfigurationContent)

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

Parámetros

deviceId: string

content: ConfigurationContent

Devoluciones

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Aplicar la configuración especificada a un dispositivo en un IoT Hub

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

Parámetros

deviceId: string

Identificador del dispositivo al que se va a aplicar la configuración

content: ConfigurationContent

Configuración que se va a aplicar

done: HttpResponseCallback<any>

cancelJob(string)

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

Parámetros

jobId: string

Devoluciones

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Cancelar un trabajo de importación o exportación masiva.

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

Parámetros

jobId: string

Identificador del trabajo para el que el usuario quiere obtener información de estado.

done: Callback<JobStatus>

La función opcional a la que se va a llamar con dos argumentos: un objeto de error si se ha producido un error (null de lo contrario) y el estado (cancelado) del trabajo cuyo identificador se pasó como argumento.

create(DeviceDescription)

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

Parámetros

deviceInfo: DeviceDescription

Devoluciones

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

Crea una nueva identidad de dispositivo en un centro de IoT.

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

Parámetros

deviceInfo: DeviceDescription

El objeto debe incluir una deviceId propiedad con un identificador de dispositivo válido.

done: HttpResponseCallback<Device>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser null), un objeto Device que representa la identidad del dispositivo creada y un objeto de respuesta específico del transporte útil para registrar o depurar.

createQuery(string, number)

Crea una consulta que se puede ejecutar en la instancia de IoT Hub para buscar información sobre dispositivos o trabajos.

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

Parámetros

sqlQuery: string

Consulta escrita como una cadena SQL.

pageSize: number

Número deseado de resultados por página (opcional. valor predeterminado: 1000, máximo: 10000).

Devoluciones

Query

delete(string)

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

Parámetros

deviceId: string

Devoluciones

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

Quita una identidad de dispositivo existente de un centro de IoT.

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

Parámetros

deviceId: string

Identificador de una identidad de dispositivo existente.

done: HttpResponseCallback<any>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser null), un argumento always-null (para la coherencia con los otros métodos) y un objeto de respuesta específico del transporte útil para registrar o depurar.

exportDevicesToBlob(string, boolean)

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

Parámetros

outputBlobContainerUri: string

excludeKeys: boolean

Devoluciones

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Exportar dispositivos a un blob en un trabajo masivo.

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

Parámetros

outputBlobContainerUri: string

El URI de un contenedor donde se creará un blob denominado "devices.txt" que contiene la lista de dispositivos.

excludeKeys: boolean

Valor booleano que indica si las claves de seguridad deben excluirse de los datos exportados.

done: Callback<JobStatus>

Función opcional a la que se llamará cuando se ha creado el trabajo, con dos argumentos: un objeto de error si se produjo un error (null de lo contrario) y el estado del trabajo que se puede usar para realizar un seguimiento del progreso de la exportación de dispositivos.

exportDevicesToBlobByIdentity(string, boolean)

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

Parámetros

outputBlobContainerUri: string

excludeKeys: boolean

Devoluciones

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Exportar dispositivos a un blob en un trabajo masivo mediante una identidad configurada.

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

Parámetros

outputBlobContainerUri: string

El URI de un contenedor donde se creará un blob denominado "devices.txt" que contiene la lista de dispositivos.

excludeKeys: boolean

Valor booleano que indica si las claves de seguridad deben excluirse de los datos exportados.

done: Callback<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string)

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

Parámetros

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

Devoluciones

Promise<JobStatus>

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

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

Parámetros

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

done: Callback<JobStatus>

fromConnectionString(string)

Construye un objeto Registry a partir de la cadena de conexión especificada.

static function fromConnectionString(value: string): Registry

Parámetros

value: string

Cadena de conexión que encapsula los permisos del Registro de lectura o escritura adecuados.

Devoluciones

Registry

fromSharedAccessSignature(string)

Construye un objeto Registry a partir de la firma de acceso compartido especificada.

static function fromSharedAccessSignature(value: string): Registry

Parámetros

value: string

Firma de acceso compartido que encapsula los permisos del Registro de lectura o escritura adecuados.

Devoluciones

Registry

fromTokenCredential(string, TokenCredential)

Construye un objeto Registry a partir del token de Azure EspecificadoCredential.

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

Parámetros

hostName: string

Nombre de host del servicio de Azure.

tokenCredential: TokenCredential

Un TokenCredential de Azure que se usa para autenticarse con el servicio de Azure

Devoluciones

Registry

get(string)

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

Parámetros

deviceId: string

Devoluciones

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

Solicita información sobre una identidad de dispositivo existente en un centro de IoT.

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

Parámetros

deviceId: string

Identificador de una identidad de dispositivo existente.

done: HttpResponseCallback<Device>

getConfiguration(string)

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

Parámetros

configurationId: string

Devoluciones

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

Obtener una única configuración de un IoT Hub

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

Parámetros

configurationId: string

Identificador de la configuración con la que se va a recuperar

done: HttpResponseCallback<Configuration>

Devolución de llamada opcional a la que se llamará con un objeto Error o un módulo:azure-iothub. Objeto de configuración con los detalles de configuración.

getConfigurations()

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

Devoluciones

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Obtener todas las configuraciones de un IoT Hub

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

Parámetros

done: HttpResponseCallback<Configuration[]>

Devolución de llamada opcional a la que se llamará con un objeto Error o una matriz de module:azure-iothub. Objetos de configuración para todas las configuraciones.

getJob(string)

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

Parámetros

jobId: string

Devoluciones

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Obtenga el estado de un trabajo de importación o exportación masiva.

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

Parámetros

jobId: string

Identificador del trabajo para el que el usuario quiere obtener información de estado.

done: Callback<JobStatus>

La función opcional que se va a llamar con dos argumentos: un objeto de error si se produjo un error (null de lo contrario) y el estado del trabajo cuyo identificador se pasó como argumento.

getModule(string, string)

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

Parámetros

deviceId: string

moduleId: string

Devoluciones

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

Obtener un único módulo de un dispositivo en una IoT Hub

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

Parámetros

deviceId: string

Id. de dispositivo que posee el módulo.

moduleId: string

Id. de módulo que se va a recuperar

done: HttpResponseCallback<Module>

Devolución de llamada opcional a la que se llamará con un objeto Error o el module:azure-iothub. Objeto Module para el módulo solicitado

getModulesOnDevice(string)

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

Parámetros

deviceId: string

Devoluciones

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

Obtener una lista de todos los módulos de un dispositivo IoT Hub

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

Parámetros

deviceId: string

Identificador del dispositivo para el que se obtienen módulos

done: HttpResponseCallback<Module[]>

Devolución de llamada opcional a la que se llamará con un objeto Error o una matriz de module:azure-iothub. Objetos module para todos los módulos.

getModuleTwin(string, string)

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

Parámetros

deviceId: string

moduleId: string

Devoluciones

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Obtiene el módulo gemelo del módulo con el identificador de módulo especificado.

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

Parámetros

deviceId: string

Identificador del dispositivo.

moduleId: string

Identificador del módulo.

done: HttpResponseCallback<Twin>

Devolución de llamada opcional a la que se llamará con un objeto Error o la instancia del módulo gemelo.

getRegistryStatistics()

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

Devoluciones

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Obtiene estadísticas sobre los dispositivos del registro de identidad del dispositivo.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Parámetros

done: HttpResponseCallback<RegistryStatistics>

Devolución de llamada opcional a la que se llamará con un objeto Error o las estadísticas del registro del dispositivo.

getTwin(string)

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

Parámetros

deviceId: string

Devoluciones

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Obtiene el dispositivo gemelo del dispositivo con el identificador de dispositivo especificado.

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

Parámetros

deviceId: string

Identificador del dispositivo.

done: HttpResponseCallback<Twin>

Devolución de llamada opcional a la que se llamará con un objeto Error o la instancia del dispositivo gemelo.

importDevicesFromBlob(string, string)

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

Parámetros

inputBlobContainerUri: string

outputBlobContainerUri: string

Devoluciones

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

Importa dispositivos desde un blob en un trabajo masivo.

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

Parámetros

inputBlobContainerUri: string

El URI de un contenedor con un blob denominado "devices.txt" que contiene una lista de dispositivos que se van a importar.

outputBlobContainerUri: string

Identificador URI de un contenedor donde se creará un blob con registros del proceso de importación.

done: Callback<JobStatus>

La función opcional a la que se llamará cuando se ha creado el trabajo, con dos argumentos: un objeto de error si se produjo un error (null de lo contrario) y el estado del trabajo que se puede usar para realizar un seguimiento del progreso de la importación de dispositivos.

importDevicesFromBlobByIdentity(string, string)

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

Parámetros

inputBlobContainerUri: string

outputBlobContainerUri: string

Devoluciones

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Importa dispositivos desde un blob en un trabajo masivo mediante una identidad configurada.

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

Parámetros

inputBlobContainerUri: string

El URI de un contenedor con un blob denominado "devices.txt" que contiene una lista de dispositivos que se van a importar.

outputBlobContainerUri: string

Identificador URI de un contenedor donde se creará un blob con registros del proceso de importación.

done: Callback<JobStatus>

importDevicesFromBlobByIdentity(string, string, string)

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

Parámetros

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

Devoluciones

Promise<JobStatus>

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

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

Parámetros

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

done: Callback<JobStatus>

list()

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

Devoluciones

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

Solicita información sobre las primeras 1000 identidades de dispositivo en un centro de IoT.

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

Parámetros

done: HttpResponseCallback<Device[]>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser NULL), una matriz de objetos Device que representan las identidades de dispositivo enumeradas y un objeto de respuesta específico del transporte útil para registrar o depurar.

listJobs()

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

Devoluciones

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Enumere los últimos trabajos de importación y exportación (incluido el activo, si existe).

function listJobs(done?: HttpResponseCallback<any>)

Parámetros

done: HttpResponseCallback<any>

La función opcional que se va a llamar con dos argumentos: un objeto de error si se produjo un error (null de lo contrario) y la lista de trabajos anteriores como argumento.

removeConfiguration(string)

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

Parámetros

configurationId: string

Devoluciones

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

Quitar una configuración con el identificador especificado de un IoT Hub

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

Parámetros

configurationId: string

Identificador de la configuración que se va a quitar

done: HttpResponseCallback<any>

removeDevices(DeviceDescription[], boolean)

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

Parámetros

devices: DeviceDescription[]

forceRemove: boolean

Devoluciones

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Novedades una matriz de dispositivos.

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

Parámetros

devices: DeviceDescription[]

Matriz de objetos que deben incluir una deviceId propiedad cuyo valor es un identificador de dispositivo válido.

forceRemove: boolean

si forceRemove es true, el dispositivo se quitará independientemente de una etag. De lo contrario, los etag deben coincidir.

done: HttpResponseCallback<BulkRegistryOperationResult>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser null), bulkRegistryOperationResult y un objeto de respuesta específico del transporte útil para el registro o la depuración.

removeModule(Module, TripleValueCallback<any, any>)

Eliminación del módulo especificado del registro

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

Parámetros

module: Module

done: TripleValueCallback<any, any>

removeModule(string | Module)

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

Parámetros

moduleOrDeviceId: string | Module

Devoluciones

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

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

Parámetros

moduleOrDeviceId: string | Module

moduleId: string

Devoluciones

Promise<ResultWithHttpResponse<any>>

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

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

Parámetros

deviceId: string

moduleId: string

done: TripleValueCallback<any, any>

update(DeviceDescription)

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

Parámetros

deviceInfo: DeviceDescription

Devoluciones

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

Novedades una identidad de dispositivo existente en un centro de IoT con la información del dispositivo especificada. El deviceInfo parámetro debe incluir todas las propiedades que son actualizables. Por ejemplo, si actualiza la status propiedad de disabled a enabled, el deviceInfo objeto también debe tener statusReason, autenticación (y sus subpropiedades), funcionalidades y deviceScope establecidos en los valores actuales de los dispositivos o se restablecerán esas propiedades. Se recomienda llamar primero a la API get antes de realizar una actualización.

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

Parámetros

deviceInfo: DeviceDescription

Objeto que debe incluir una deviceId propiedad cuyo valor es un identificador de dispositivo válido.

done: HttpResponseCallback<Device>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser null), un objeto Device que representa la identidad del dispositivo actualizada y un objeto de respuesta específico del transporte útil para registrar o depurar.

updateConfiguration(Configuration)

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

Parámetros

configuration: Configuration

Devoluciones

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

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

Parámetros

configuration: Configuration

forceUpdate: boolean

Devoluciones

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

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

Parámetros

configuration: Configuration

forceUpdate: boolean

done: HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

Actualización de una configuración en un centro de IoT

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

Parámetros

configuration: Configuration

Objeto de tipo module:azure-iothub. Configuración que se va a agregar al centro

done: HttpResponseCallback<any>

updateDevices(DeviceDescription[], boolean)

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

Parámetros

devices: DeviceDescription[]

forceUpdate: boolean

Devoluciones

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Novedades una matriz de dispositivos. Los elementos individuales del devices parámetro deben incluir todas las propiedades que son actualizables. Por ejemplo, si actualiza la status propiedad de disabled a enabled, el objeto también debe tener statusReason, autenticación (y sus subpropiedades), funcionalidades y deviceScope establecidos en los valores actuales de los dispositivos o esas propiedades se restablecerán. Se recomienda llamar primero a la API get antes de realizar una actualización.

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

Parámetros

devices: DeviceDescription[]

Matriz de objetos que deben incluir una deviceId propiedad cuyo valor es un identificador de dispositivo válido.

forceUpdate: boolean

si forceUpdate es true, el dispositivo se actualizará independientemente de una etag. De lo contrario, las etiquetas electrónicas deben coincidir.

done: HttpResponseCallback<BulkRegistryOperationResult>

updateModule(Module)

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

Parámetros

module: Module

Devoluciones

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

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

Parámetros

module: Module

forceUpdate: boolean

Devoluciones

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

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

Parámetros

module: Module

forceUpdate: boolean

done: HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

Actualización del objeto de módulo especificado en el Registro

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

Parámetros

module: Module

Objeto module que se va a actualizar.

done: TripleValueCallback<any, any>

updateModuleTwin(string, string, any, string)

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

Parámetros

deviceId: string

moduleId: string

patch: any

etag: string

Devoluciones

Promise<ResultWithHttpResponse<Twin>>

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

Novedades el gemelo de un módulo específico con la revisión especificada.

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

Parámetros

deviceId: string

Identificador del dispositivo.

moduleId: string

Identificador del módulo

patch: any

Las propiedades y etiquetas deseadas para aplicar revisiones al módulo gemelo.

etag: string

El etag más reciente de este módulo gemelo o "*" para forzar una actualización incluso si el módulo gemelo se ha actualizado desde que se obtuvo la etag.

done: HttpResponseCallback<Twin>

Devolución de llamada opcional a la que se llamará con un objeto Error o la instancia del módulo gemelo.

updateTwin(string, any, string)

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

Parámetros

deviceId: string

patch: any

etag: string

Devoluciones

Promise<ResultWithHttpResponse<Twin>>

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

Novedades el dispositivo gemelo de un dispositivo específico con la revisión especificada.

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

Parámetros

deviceId: string

Identificador del dispositivo.

patch: any

Las propiedades y etiquetas deseadas para aplicar revisiones al dispositivo gemelo.

etag: string

El etag más reciente de este dispositivo gemelo o "*" para forzar una actualización incluso si el dispositivo gemelo se ha actualizado desde que se obtuvo la etag.

done: HttpResponseCallback<Twin>

Devolución de llamada opcional a la que se llamará con un objeto Error o la instancia del dispositivo gemelo.