RegistryManager class

Create a RegistryManager.

new RegistryManager(client: IotHubGatewayServiceAPIsContext)

Parameters

Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).

function bulkDeviceCRUD(devices: ExportImportDevice[], options?: msRest.RequestOptionsBase)

Parameters

Returns

Promise<Models.RegistryManagerBulkDeviceCRUDResponse>

function bulkDeviceCRUD(devices: ExportImportDevice[], options: RequestOptionsBase, callback: ServiceCallback<BulkRegistryOperationResult>)

Parameters

function bulkDeviceCRUD(devices: ExportImportDevice[], callback: ServiceCallback<BulkRegistryOperationResult>)

Parameters

Create or update the identity of a device in the identity registry of an IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that generationId and deviceId cannot be updated by the user.

function createOrUpdateDevice(id: string, device: Device, options?: Models.RegistryManagerCreateOrUpdateDeviceOptionalParams)

Parameters

Returns

Promise<Models.RegistryManagerCreateOrUpdateDeviceResponse>

function createOrUpdateDevice(id: string, device: Device, options: RegistryManagerCreateOrUpdateDeviceOptionalParams, callback: ServiceCallback<Device>)

Parameters

function createOrUpdateDevice(id: string, device: Device, callback: ServiceCallback<Device>)

Parameters

function createOrUpdateModule(id: string, mid: string, module: Module, options?: Models.RegistryManagerCreateOrUpdateModuleOptionalParams)

Parameters

Returns

Promise<Models.RegistryManagerCreateOrUpdateModuleResponse>

function createOrUpdateModule(id: string, mid: string, module: Module, options: RegistryManagerCreateOrUpdateModuleOptionalParams, callback: ServiceCallback<Module>)

Parameters

function createOrUpdateModule(id: string, mid: string, module: Module, callback: ServiceCallback<Module>)

Parameters

Delete the identity of a device from the identity registry of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*).

function deleteDevice(id: string, options?: Models.RegistryManagerDeleteDeviceOptionalParams)

Parameters

Returns

Promise<msRest.RestResponse>

function deleteDevice(id: string, options: RegistryManagerDeleteDeviceOptionalParams, callback: ServiceCallback<void>)

Parameters

function deleteDevice(id: string, callback: ServiceCallback<void>)

Parameters

function deleteModule(id: string, mid: string, options?: Models.RegistryManagerDeleteModuleOptionalParams)

Parameters

Returns

Promise<msRest.RestResponse>

function deleteModule(id: string, mid: string, options: RegistryManagerDeleteModuleOptionalParams, callback: ServiceCallback<void>)

Parameters

function deleteModule(id: string, mid: string, callback: ServiceCallback<void>)

Parameters

Retrieve a device from the identity registry of an IoT hub.

function getDevice(id: string, options?: msRest.RequestOptionsBase)

Parameters

Returns

Promise<Models.RegistryManagerGetDeviceResponse>

function getDevice(id: string, options: RequestOptionsBase, callback: ServiceCallback<Device>)

Parameters

function getDevice(id: string, callback: ServiceCallback<Device>)

Parameters

function getDevices(options?: Models.RegistryManagerGetDevicesOptionalParams)

Parameters

Returns

Promise<Models.RegistryManagerGetDevicesResponse>

function getDevices(options: RegistryManagerGetDevicesOptionalParams, callback: ServiceCallback<Device[]>)

Parameters

function getDevices(callback: ServiceCallback<Device[]>)

Parameters

function getDeviceStatistics(options?: msRest.RequestOptionsBase)

Parameters

Returns

Promise<Models.RegistryManagerGetDeviceStatisticsResponse>

function getDeviceStatistics(options: RequestOptionsBase, callback: ServiceCallback<RegistryStatistics>)

Parameters

function getDeviceStatistics(callback: ServiceCallback<RegistryStatistics>)

Parameters

function getModule(id: string, mid: string, options?: msRest.RequestOptionsBase)

Parameters

Returns

Promise<Models.RegistryManagerGetModuleResponse>

function getModule(id: string, mid: string, options: RequestOptionsBase, callback: ServiceCallback<Module>)

Parameters

function getModule(id: string, mid: string, callback: ServiceCallback<Module>)

Parameters

function getModulesOnDevice(id: string, options?: msRest.RequestOptionsBase)

Parameters

Returns

Promise<Models.RegistryManagerGetModulesOnDeviceResponse>

function getModulesOnDevice(id: string, options: RequestOptionsBase, callback: ServiceCallback<Module[]>)

Parameters

function getModulesOnDevice(id: string, callback: ServiceCallback<Module[]>)

Parameters

function getServiceStatistics(options?: msRest.RequestOptionsBase)

Parameters

Returns

Promise<Models.RegistryManagerGetServiceStatisticsResponse>

function getServiceStatistics(options: RequestOptionsBase, callback: ServiceCallback<ServiceStatistics>)

Parameters

function getServiceStatistics(callback: ServiceCallback<ServiceStatistics>)

Parameters

Deletes all the pending commands for this device from the IoT hub

function purgeCommandQueue(id: string, options?: msRest.RequestOptionsBase)

Parameters

Returns

Promise<Models.RegistryManagerPurgeCommandQueueResponse>

function purgeCommandQueue(id: string, options: RequestOptionsBase, callback: ServiceCallback<PurgeMessageQueueResult>)

Parameters

function purgeCommandQueue(id: string, callback: ServiceCallback<PurgeMessageQueueResult>)

Parameters

Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about device twins only.

function queryIotHub(querySpecification: QuerySpecification, options?: Models.RegistryManagerQueryIotHubOptionalParams)

Parameters

Returns

Promise<Models.RegistryManagerQueryIotHubResponse>

function queryIotHub(querySpecification: QuerySpecification, options: RegistryManagerQueryIotHubOptionalParams, callback: ServiceCallback<Twin[]>)

Parameters

function queryIotHub(querySpecification: QuerySpecification, callback: ServiceCallback<Twin[]>)

Parameters