Registry class

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

Parámetros

Devoluciones

Agregue una configuración a un centro de IoT.

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

Parámetros

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

Parámetros

Devoluciones

Agrega una matriz de dispositivos.

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

Parámetros

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

Parámetros

Devoluciones

Agregue el módulo especificado al Registro.

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

Parámetros

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

Parámetros

Devoluciones

Aplicación de la configuración dada a un dispositivo en una instancia de IoT Hub

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

Parámetros

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

Parámetros

Devoluciones

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

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

Parámetros

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

Parámetros

Devoluciones

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

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

Parámetros

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

Devoluciones

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

Parámetros

Devoluciones

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

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

Parámetros

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

Parámetros

Devoluciones

Exportar dispositivos a un blob en un trabajo masivo.

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

Parámetros

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

Parámetros

Devoluciones

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

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

Parámetros

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

Parámetros

Devoluciones

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

Parámetros

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

static function fromConnectionString(value: string): Registry

Parámetros

Devoluciones

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

static function fromSharedAccessSignature(value: string): Registry

Parámetros

Devoluciones

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

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

Parámetros

Devoluciones

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

Parámetros

Devoluciones

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

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

Parámetros

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

Parámetros

Devoluciones

Obtención de una única configuración desde una instancia de IoT Hub

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

Parámetros

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

Devoluciones

Obtención de todas las configuraciones en una instancia de IoT Hub

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

Parámetros

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

Parámetros

Devoluciones

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

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

Parámetros

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

Parámetros

Devoluciones

Obtención de un único módulo de un dispositivo en una instancia de IoT Hub

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

Parámetros

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

Parámetros

Devoluciones

Obtención de una lista de todos los módulos en un dispositivo de IoT Hub

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

Parámetros

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

Parámetros

Devoluciones

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

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

Devoluciones

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

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Parámetros

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

Parámetros

Devoluciones

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

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

Parámetros

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

Parámetros

Devoluciones

Importa dispositivos desde un blob en un trabajo masivo.

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

Parámetros

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

Parámetros

Devoluciones

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

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

Parámetros

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

Parámetros

Devoluciones

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

Parámetros

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

Devoluciones

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

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

Parámetros

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

Devoluciones

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

function listJobs(done?: HttpResponseCallback<any>)

Parámetros

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

Parámetros

Devoluciones

Eliminación de una configuración con el identificador especificado de una instancia de IoT Hub

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

Parámetros

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

Parámetros

Devoluciones

Actualiza una matriz de dispositivos.

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

Parámetros

Eliminación del módulo especificado del Registro

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

Parámetros

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

Parámetros

Devoluciones

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

Parámetros

Devoluciones

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

Parámetros

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

Parámetros

Devoluciones

Actualiza una identidad de dispositivo existente en un centro de IoT con la información de dispositivo especificada. El parámetro deviceInfo debe incluir todas las propiedades actualizables. Por ejemplo, si actualiza la propiedad status de disabled a enabled, el objeto deviceInfo 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

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

Parámetros

Devoluciones

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

Parámetros

Devoluciones

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

Parámetros

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

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

Parámetros

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

Parámetros

Devoluciones

Actualiza una matriz de dispositivos. Los elementos individuales del parámetro devices deben incluir todas las propiedades actualizables. Por ejemplo, si actualiza la propiedad status 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 se restablecerán esas propiedades. 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

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

Parámetros

Devoluciones

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

Parámetros

Devoluciones

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

Parámetros

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

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

Parámetros

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

Parámetros

Devoluciones

Actualiza 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

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

Parámetros

Devoluciones

Actualiza 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