DevicesClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Subclient of IotHubServiceClient that handles all device registry operations including getting/creating/setting/deleting device identities, getting modules on a device, and getting device registry statistics.
public class DevicesClienttype DevicesClient = classPublic Class DevicesClient- Inheritance
-
DevicesClient
Constructors
| DevicesClient() |
Creates an instance of this class. Provided for unit testing purposes only. |
Methods
| CancelJobAsync(String, CancellationToken) |
Cancels/deletes the job with the specified Id. |
| CreateAsync(Device, CancellationToken) |
Create a device identity in your IoT hub's registry. |
| CreateAsync(IEnumerable<Device>, CancellationToken) |
Create up to 100 new device identities in your IoT hub's registry in bulk. |
| CreateWithTwinAsync(Device, ClientTwin, CancellationToken) |
Create a device identity in your IoT hub's registry with an initial twin state. |
| DeleteAsync(Device, Boolean, CancellationToken) |
Delete the device identity with the provided Id from your IoT hub's registry. |
| DeleteAsync(IEnumerable<Device>, Boolean, CancellationToken) |
Delete up to 100 device identities from your IoT hub's registry in bulk. |
| DeleteAsync(String, CancellationToken) |
Delete the device identity with the provided Id from your IoT hub's registry. |
| ExportAsync(ExportJobProperties, CancellationToken) |
Creates a new bulk job to export device registrations to the container specified by the provided URI. |
| GetAsync(String, CancellationToken) |
Get a device identity by its Id. |
| GetJobAsync(String, CancellationToken) |
Gets the registry job with the specified Id. |
| GetJobsAsync(CancellationToken) |
List all registry jobs for the IoT hub. |
| GetModulesAsync(String, CancellationToken) |
Get all the modules that are registered on a particular device. |
| GetRegistryStatisticsAsync(CancellationToken) |
Gets the registry statistics for your IoT hub. |
| GetServiceStatisticsAsync(CancellationToken) |
Gets service statistics for the IoT hub. This call is made over HTTP. |
| ImportAsync(ImportJobProperties, CancellationToken) |
Creates a new bulk job to import device registrations into the IoT hub. |
| SetAsync(Device, Boolean, CancellationToken) |
Replace a device identity's state with the provided device identity's state. |
| SetAsync(IEnumerable<Device>, Boolean, CancellationToken) |
Update up to 100 device identities in your IoT hub's registry in bulk. |
