DeviceManagementClient 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.
The DeviceManagementClient.
public class DeviceManagementClienttype DeviceManagementClient = classPublic Class DeviceManagementClient- Inheritance
-
DeviceManagementClient
Constructors
| Name | Description |
|---|---|
| DeviceManagementClient() |
Initializes a new instance of DeviceManagementClient for mocking. |
| DeviceManagementClient(DeviceManagementClientSettings) |
Initializes a new instance of DeviceManagementClient from a DeviceManagementClientSettings. |
| DeviceManagementClient(Uri, String, TokenCredential, DeviceUpdateClientOptions) |
Initializes a new instance of DeviceManagementClient. |
| DeviceManagementClient(Uri, String, TokenCredential) |
Initializes a new instance of DeviceManagementClient. |
Properties
| Name | Description |
|---|---|
| Pipeline |
The HTTP pipeline for sending and receiving REST requests and responses. |
Methods
| Name | Description |
|---|---|
| CreateOrUpdateDeployment(String, String, RequestContent, RequestContext) |
[Protocol Method] Creates or updates a deployment.
|
| CreateOrUpdateDeploymentAsync(String, String, RequestContent, RequestContext) |
[Protocol Method] Creates or updates a deployment.
|
| DeleteDeployment(String, String, RequestContext) |
[Protocol Method] Deletes a deployment.
|
| DeleteDeploymentAsync(String, String, RequestContext) |
[Protocol Method] Deletes a deployment.
|
| DeleteDeploymentForDeviceClassSubgroup(String, String, String, RequestContext) |
[Protocol Method] Deletes a device class subgroup deployment.
|
| DeleteDeploymentForDeviceClassSubgroupAsync(String, String, String, RequestContext) |
[Protocol Method] Deletes a device class subgroup deployment.
|
| DeleteDeviceClass(String, RequestContext) |
[Protocol Method] Deletes a device class. Device classes are created automatically when Device Update-enabled devices are connected to the hub but are not automatically cleaned up since they are referenced by DeviceClassSubgroups. If the user has deleted all DeviceClassSubgroups for a device class they can also delete the device class to remove the records from the system and to stop checking the compatibility of this device class with new updates. If a device is ever reconnected for this device class it will be re-created.
|
| DeleteDeviceClassAsync(String, RequestContext) |
[Protocol Method] Deletes a device class. Device classes are created automatically when Device Update-enabled devices are connected to the hub but are not automatically cleaned up since they are referenced by DeviceClassSubgroups. If the user has deleted all DeviceClassSubgroups for a device class they can also delete the device class to remove the records from the system and to stop checking the compatibility of this device class with new updates. If a device is ever reconnected for this device class it will be re-created.
|
| DeleteDeviceClassSubgroup(String, String, RequestContext) |
[Protocol Method] Deletes a device class subgroup. This subgroup is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a subgroup if they do not need to retain any of the history of the subgroup and no longer need it. If a device is ever connected again for this subgroup after the subgroup was deleted it will be automatically re-created but there will be no history.
|
| DeleteDeviceClassSubgroupAsync(String, String, RequestContext) |
[Protocol Method] Deletes a device class subgroup. This subgroup is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a subgroup if they do not need to retain any of the history of the subgroup and no longer need it. If a device is ever connected again for this subgroup after the subgroup was deleted it will be automatically re-created but there will be no history.
|
| DeleteGroup(String, RequestContext) |
[Protocol Method] Deletes a device group. This group is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a group if they do not need to retain any of the history of the group and no longer need it. If a device is ever connected again for this group after the group was deleted it will be automatically re-created but there will be no history.
|
| DeleteGroupAsync(String, RequestContext) |
[Protocol Method] Deletes a device group. This group is automatically created when a Device Update-enabled device is connected to the hub and reports its properties. Groups, subgroups, and deployments are not automatically cleaned up but are retained for history purposes. Users can call this method to delete a group if they do not need to retain any of the history of the group and no longer need it. If a device is ever connected again for this group after the group was deleted it will be automatically re-created but there will be no history.
|
| GetBestUpdatesForDeviceClassSubgroup(String, String, RequestContext) |
[Protocol Method] Get the best available update for a device class subgroup and a count of how many devices need this update.
|
| GetBestUpdatesForDeviceClassSubgroupAsync(String, String, RequestContext) |
[Protocol Method] Get the best available update for a device class subgroup and a count of how many devices need this update.
|
| GetBestUpdatesForGroups(String, RequestContext) |
[Protocol Method] Get the best available updates for a device group and a count of how many devices need each update.
|
| GetBestUpdatesForGroupsAsync(String, RequestContext) |
[Protocol Method] Get the best available updates for a device group and a count of how many devices need each update.
|
| GetDeployment(String, String, RequestContext) |
[Protocol Method] Gets the deployment properties.
|
| GetDeploymentAsync(String, String, RequestContext) |
[Protocol Method] Gets the deployment properties.
|
| GetDeploymentForDeviceClassSubgroup(String, String, String, RequestContext) |
[Protocol Method] Gets the deployment properties.
|
| GetDeploymentForDeviceClassSubgroupAsync(String, String, String, RequestContext) |
[Protocol Method] Gets the deployment properties.
|
| GetDeploymentsForDeviceClassSubgroups(String, String, String, RequestContext) |
[Protocol Method] Gets a list of deployments for a device class subgroup.
|
| GetDeploymentsForDeviceClassSubgroupsAsync(String, String, String, RequestContext) |
[Protocol Method] Gets a list of deployments for a device class subgroup.
|
| GetDeploymentsForGroups(String, String, RequestContext) |
[Protocol Method] Gets a list of deployments for a device group.
|
| GetDeploymentsForGroupsAsync(String, String, RequestContext) |
[Protocol Method] Gets a list of deployments for a device group.
|
| GetDeploymentStatus(String, String, RequestContext) |
[Protocol Method] Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
|
| GetDeploymentStatusAsync(String, String, RequestContext) |
[Protocol Method] Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
|
| GetDevice(String, RequestContext) |
[Protocol Method] Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.
|
| GetDeviceAsync(String, RequestContext) |
[Protocol Method] Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.
|
| GetDeviceClass(String, RequestContext) |
[Protocol Method] Gets the properties of a device class.
|
| GetDeviceClassAsync(String, RequestContext) |
[Protocol Method] Gets the properties of a device class.
|
| GetDeviceClasses(String, RequestContext) |
[Protocol Method] Gets a list of all device classes (sets of devices compatible with the same updates based on the model Id and compat properties reported in the Device Update PnP interface in IoT Hub) for all devices connected to Device Update for IoT Hub.
|
| GetDeviceClassesAsync(String, RequestContext) |
[Protocol Method] Gets a list of all device classes (sets of devices compatible with the same updates based on the model Id and compat properties reported in the Device Update PnP interface in IoT Hub) for all devices connected to Device Update for IoT Hub.
|
| GetDeviceClassSubgroup(String, String, RequestContext) |
[Protocol Method] Gets device class subgroup details. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates.
|
| GetDeviceClassSubgroupAsync(String, String, RequestContext) |
[Protocol Method] Gets device class subgroup details. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates.
|
| GetDeviceClassSubgroupDeploymentStatus(String, String, String, RequestContext) |
[Protocol Method] Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
|
| GetDeviceClassSubgroupDeploymentStatusAsync(String, String, String, RequestContext) |
[Protocol Method] Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
|
| GetDeviceClassSubgroupsForGroups(String, String, RequestContext) |
[Protocol Method] Get the device class subgroups for the group. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates.
|
| GetDeviceClassSubgroupsForGroupsAsync(String, String, RequestContext) |
[Protocol Method] Get the device class subgroups for the group. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates.
|
| GetDeviceClassSubgroupUpdateCompliance(String, String, RequestContext) |
[Protocol Method] Get device class subgroup update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.
|
| GetDeviceClassSubgroupUpdateComplianceAsync(String, String, RequestContext) |
[Protocol Method] Get device class subgroup update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.
|
| GetDeviceModule(String, String, RequestContext) |
[Protocol Method] Gets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub.
|
| GetDeviceModuleAsync(String, String, RequestContext) |
[Protocol Method] Gets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub.
|
| GetDevices(String, RequestContext) |
[Protocol Method] Gets a list of devices connected to Device Update for IoT Hub.
|
| GetDevicesAsync(String, RequestContext) |
[Protocol Method] Gets a list of devices connected to Device Update for IoT Hub.
|
| GetDeviceStatesForDeviceClassSubgroupDeployments(String, String, String, String, RequestContext) |
[Protocol Method] Gets a list of devices in a deployment along with their state. Useful for getting a list of failed devices.
|
| GetDeviceStatesForDeviceClassSubgroupDeploymentsAsync(String, String, String, String, RequestContext) |
[Protocol Method] Gets a list of devices in a deployment along with their state. Useful for getting a list of failed devices.
|
| GetGroup(String, RequestContext) |
[Protocol Method] Gets the device group properties.
|
| GetGroupAsync(String, RequestContext) |
[Protocol Method] Gets the device group properties.
|
| GetGroups(String, RequestContext) |
[Protocol Method] Gets a list of all device groups. The $default group will always be returned first.
|
| GetGroupsAsync(String, RequestContext) |
[Protocol Method] Gets a list of all device groups. The $default group will always be returned first.
|
| GetHealthOfDevices(String, RequestContext) |
[Protocol Method] Get list of device health
|
| GetHealthOfDevicesAsync(String, RequestContext) |
[Protocol Method] Get list of device health
|
| GetInstallableUpdatesForDeviceClasses(String, RequestContext) |
[Protocol Method] Gets a list of installable updates for a device class.
|
| GetInstallableUpdatesForDeviceClassesAsync(String, RequestContext) |
[Protocol Method] Gets a list of installable updates for a device class.
|
| GetLogCollection(String, RequestContext) |
[Protocol Method] Get the device diagnostics log collection
|
| GetLogCollectionAsync(String, RequestContext) |
[Protocol Method] Get the device diagnostics log collection
|
| GetLogCollectionDetailedStatus(String, RequestContext) |
[Protocol Method] Get log collection with detailed status
|
| GetLogCollectionDetailedStatusAsync(String, RequestContext) |
[Protocol Method] Get log collection with detailed status
|
| GetLogCollections(RequestContext) |
[Protocol Method] Get all device diagnostics log collections
|
| GetLogCollectionsAsync(RequestContext) |
[Protocol Method] Get all device diagnostics log collections
|
| GetOperationStatus(String, Nullable<ETag>, RequestContext) |
[Protocol Method] Retrieve operation status.
|
| GetOperationStatusAsync(String, Nullable<ETag>, RequestContext) |
[Protocol Method] Retrieve operation status.
|
| GetOperationStatuses(String, Nullable<Int32>, RequestContext) |
[Protocol Method] Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted.
|
| GetOperationStatusesAsync(String, Nullable<Int32>, RequestContext) |
[Protocol Method] Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted.
|
| GetUpdateCompliance(RequestContext) |
[Protocol Method] Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.
|
| GetUpdateComplianceAsync(RequestContext) |
[Protocol Method] Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.
|
| GetUpdateComplianceForGroup(String, RequestContext) |
[Protocol Method] Get device group update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.
|
| GetUpdateComplianceForGroupAsync(String, RequestContext) |
[Protocol Method] Get device group update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.
|
| ImportDevices(WaitUntil, RequestContent, RequestContext) |
Import existing devices from IoT Hub. This is a long-running-operation; use Operation-Location response header value to check for operation status. |
| ImportDevicesAsync(WaitUntil, RequestContent, RequestContext) |
Import existing devices from IoT Hub. This is a long-running-operation; use Operation-Location response header value to check for operation status. |
| RetryDeployment(String, String, String, RequestContext) |
[Protocol Method] Retries a deployment with failed devices.
|
| RetryDeploymentAsync(String, String, String, RequestContext) |
[Protocol Method] Retries a deployment with failed devices.
|
| StartLogCollection(String, RequestContent, RequestContext) |
[Protocol Method] Start the device diagnostics log collection on specified devices.
|
| StartLogCollectionAsync(String, RequestContent, RequestContext) |
[Protocol Method] Start the device diagnostics log collection on specified devices.
|
| StopDeployment(String, String, String, RequestContext) |
[Protocol Method] Stops a deployment.
|
| StopDeploymentAsync(String, String, String, RequestContext) |
[Protocol Method] Stops a deployment.
|
| UpdateDeviceClass(String, RequestContent, RequestContext) |
[Protocol Method] Update device class details.
|
| UpdateDeviceClassAsync(String, RequestContent, RequestContext) |
[Protocol Method] Update device class details.
|
