java.lang.Object
- com.azure.iot.deviceupdate.DeviceManagementAsyncClient

```
public final class DeviceManagementAsyncClient
extends Object
```
Initializes a new instance of the asynchronous DeviceUpdateClient type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>`	`beginImportDevices(com.azure.core.util.BinaryData importType, com.azure.core.http.rest.RequestOptions requestOptions)`	Import existing devices from IoT Hub.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`collectLogsWithResponse(String operationId, com.azure.core.util.BinaryData logCollectionRequest, com.azure.core.http.rest.RequestOptions requestOptions)`	Start the device diagnostics log collection operation on specified devices.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`createOrUpdateDeploymentWithResponse(String deploymentId, String groupId, com.azure.core.util.BinaryData deployment, com.azure.core.http.rest.RequestOptions requestOptions)`	Creates or updates a deployment.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`createOrUpdateGroupWithResponse(String groupId, com.azure.core.util.BinaryData group, com.azure.core.http.rest.RequestOptions requestOptions)`	Create or update a device group.
`Mono<com.azure.core.http.rest.Response<Void>>`	`deleteDeploymentWithResponse(String groupId, String deploymentId, com.azure.core.http.rest.RequestOptions requestOptions)`	Deletes a deployment.
`Mono<com.azure.core.http.rest.Response<Void>>`	`deleteGroupWithResponse(String groupId, com.azure.core.http.rest.RequestOptions requestOptions)`	Deletes a device group.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getDeploymentStatusWithResponse(String groupId, String deploymentId, com.azure.core.http.rest.RequestOptions requestOptions)`	Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getDeploymentWithResponse(String groupId, String deploymentId, com.azure.core.http.rest.RequestOptions requestOptions)`	Gets the properties of a deployment.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getDeviceClassWithResponse(String deviceClassId, com.azure.core.http.rest.RequestOptions requestOptions)`	Gets the properties of a device class.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getDeviceModuleWithResponse(String deviceId, String moduleId, com.azure.core.http.rest.RequestOptions requestOptions)`	Gets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getDeviceTagWithResponse(String tagName, com.azure.core.http.rest.RequestOptions requestOptions)`	Gets a count of how many devices have a device tag.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getDeviceWithResponse(String deviceId, com.azure.core.http.rest.RequestOptions requestOptions)`	Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getGroupUpdateComplianceWithResponse(String groupId, com.azure.core.http.rest.RequestOptions requestOptions)`	Get 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.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getGroupWithResponse(String groupId, com.azure.core.http.rest.RequestOptions requestOptions)`	Gets the properties of a group.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getLogCollectionOperationDetailedStatusWithResponse(String operationId, com.azure.core.http.rest.RequestOptions requestOptions)`	Get device diagnostics log collection operation with detailed status.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getLogCollectionOperationWithResponse(String operationId, com.azure.core.http.rest.RequestOptions requestOptions)`	Get the device diagnostics log collection operation.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getOperationWithResponse(String operationId, com.azure.core.http.rest.RequestOptions requestOptions)`	Retrieve operation status.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`getUpdateComplianceWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)`	Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.
`Mono<com.azure.core.http.rest.Response<Void>>`	`importDevicesWithResponse(com.azure.core.util.BinaryData importType, com.azure.core.http.rest.RequestOptions requestOptions)`	Import existing devices from IoT Hub.
`com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>`	`listBestUpdatesForGroup(String groupId, com.azure.core.http.rest.RequestOptions requestOptions)`	Get the best available updates for a group and a count of how many devices need each update.
`com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>`	`listDeploymentDevices(String groupId, String deploymentId, com.azure.core.http.rest.RequestOptions requestOptions)`	Gets a list of devices in a deployment along with their state.
`com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>`	`listDeploymentsForGroup(String groupId, com.azure.core.http.rest.RequestOptions requestOptions)`	Gets a list of deployments for a group.
`com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>`	`listDeviceClasses(com.azure.core.http.rest.RequestOptions requestOptions)`	Gets a list of all device classes (unique combinations of device manufacturer and model) for all devices connected to Device Update for IoT Hub.
`com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>`	`listDevices(com.azure.core.http.rest.RequestOptions requestOptions)`	Gets a list of devices connected to Device Update for IoT Hub.
`com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>`	`listDeviceTags(com.azure.core.http.rest.RequestOptions requestOptions)`	Gets a list of available group device tags for all devices connected to Device Update for IoT Hub.
`com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>`	`listGroups(com.azure.core.http.rest.RequestOptions requestOptions)`	Gets a list of all device groups.
`com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>`	`listInstallableUpdatesForDeviceClass(String deviceClassId, com.azure.core.http.rest.RequestOptions requestOptions)`	Gets a list of installable updates for a device class.
`com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>`	`listLogCollectionOperations(com.azure.core.http.rest.RequestOptions requestOptions)`	Get all device diagnostics log collection operations.
`com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>`	`listOperations(com.azure.core.http.rest.RequestOptions requestOptions)`	Get a list of all device import operations.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`retryDeploymentWithResponse(String groupId, String deploymentId, com.azure.core.http.rest.RequestOptions requestOptions)`	Retries a deployment with failed devices.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`stopDeploymentWithResponse(String groupId, String deploymentId, com.azure.core.http.rest.RequestOptions requestOptions)`	Stops a deployment.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

listDeviceClasses
```
public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listDeviceClasses(com.azure.core.http.rest.RequestOptions requestOptions)
```
Gets a list of all device classes (unique combinations of device manufacturer and model) for all devices connected to Device Update for IoT Hub.
Query Parameters
Query Parameters
Name Type Required Description

apiVersion String Yes Api Version

Response Body Schema
```
 {
     value: [
         {
             deviceClassId: String
             compatProperties: {
                 String: String
             }
             bestCompatibleUpdateId: {
                 provider: String
                 name: String
                 version: String
             }
         }
     ]
     nextLink: String
 }
 
```
Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a list of all device classes (unique combinations of device manufacturer and model) for all devices connected to Device Update for IoT Hub.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getDeviceClassWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getDeviceClassWithResponse(String deviceClassId,
                                                                                                          com.azure.core.http.rest.RequestOptions requestOptions)

Gets the properties of a device class.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     deviceClassId: String
     compatProperties: {
         String: String
     }
     bestCompatibleUpdateId: {
         provider: String
         name: String
         version: String
     }
 }

Parameters:: deviceClassId - Device class identifier.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the properties of a device class along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

listInstallableUpdatesForDeviceClass
```
public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listInstallableUpdatesForDeviceClass(String deviceClassId,
                                                                                                               com.azure.core.http.rest.RequestOptions requestOptions)
```
Gets a list of installable updates for a device class.
Query Parameters
Query Parameters
Name Type Required Description

apiVersion String Yes Api Version

Response Body Schema
```
 {
     value: [
         {
             provider: String
             name: String
             version: String
         }
     ]
     nextLink: String
 }
 
```
Parameters:

deviceClassId - Device class identifier.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a list of installable updates for a device class.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

listDevices

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listDevices(com.azure.core.http.rest.RequestOptions requestOptions)

Gets a list of devices connected to Device Update for IoT Hub.

Query Parameters

Query Parameters
Name	Type	Required	Description
filter	String	No	Restricts the set of devices returned. You can filter on device GroupId or DeviceClassId.
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     value: [
         {
             deviceId: String
             moduleId: String
             deviceClassId: String
             manufacturer: String
             model: String
             groupId: String
             lastAttemptedUpdateId: {
                 provider: String
                 name: String
                 version: String
             }
             deploymentStatus: String(Succeeded/InProgress/Failed/Canceled/Incompatible)
             installedUpdateId: (recursive schema, see installedUpdateId above)
             onLatestUpdate: boolean
             lastDeploymentId: String
             lastInstallResult: {
                 resultCode: int
                 extendedResultCode: int
                 resultDetails: String
                 stepResults: [
                     {
                         updateId: (recursive schema, see updateId above)
                         description: String
                         resultCode: int
                         extendedResultCode: int
                         resultDetails: String
                     }
                 ]
             }
         }
     ]
     nextLink: String
 }

Parameters:: requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: a list of devices connected to Device Update for IoT Hub.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

importDevicesWithResponse
```
public Mono<com.azure.core.http.rest.Response<Void>> importDevicesWithResponse(com.azure.core.util.BinaryData importType,
                                                                               com.azure.core.http.rest.RequestOptions requestOptions)
```
Import existing devices from IoT Hub.
Query Parameters
Query Parameters
Name Type Required Description

apiVersion String Yes Api Version

action String Yes Devices action.

Request Body Schema
```
 String(Devices/Modules/All)
 
```
Parameters:

importType - The types of devices to import.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

beginImportDevices
```
public com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginImportDevices(com.azure.core.util.BinaryData importType,
                                                                                                                                      com.azure.core.http.rest.RequestOptions requestOptions)
```
Import existing devices from IoT Hub.
Query Parameters
Query Parameters
Name Type Required Description

apiVersion String Yes Api Version

action String Yes Devices action.

Request Body Schema
```
 String(Devices/Modules/All)
 
```
Parameters:

importType - The types of devices to import.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getDeviceWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getDeviceWithResponse(String deviceId,
                                                                                                     com.azure.core.http.rest.RequestOptions requestOptions)

Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     deviceId: String
     moduleId: String
     deviceClassId: String
     manufacturer: String
     model: String
     groupId: String
     lastAttemptedUpdateId: {
         provider: String
         name: String
         version: String
     }
     deploymentStatus: String(Succeeded/InProgress/Failed/Canceled/Incompatible)
     installedUpdateId: (recursive schema, see installedUpdateId above)
     onLatestUpdate: boolean
     lastDeploymentId: String
     lastInstallResult: {
         resultCode: int
         extendedResultCode: int
         resultDetails: String
         stepResults: [
             {
                 updateId: (recursive schema, see updateId above)
                 description: String
                 resultCode: int
                 extendedResultCode: int
                 resultDetails: String
             }
         ]
     }
 }

Parameters:: deviceId - Device identifier in Azure IoT Hub.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the device properties and latest deployment status for a device connected to Device Update for IoT Hub along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getDeviceModuleWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getDeviceModuleWithResponse(String deviceId,
                                                                                                           String moduleId,
                                                                                                           com.azure.core.http.rest.RequestOptions requestOptions)

Gets the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     deviceId: String
     moduleId: String
     deviceClassId: String
     manufacturer: String
     model: String
     groupId: String
     lastAttemptedUpdateId: {
         provider: String
         name: String
         version: String
     }
     deploymentStatus: String(Succeeded/InProgress/Failed/Canceled/Incompatible)
     installedUpdateId: (recursive schema, see installedUpdateId above)
     onLatestUpdate: boolean
     lastDeploymentId: String
     lastInstallResult: {
         resultCode: int
         extendedResultCode: int
         resultDetails: String
         stepResults: [
             {
                 updateId: (recursive schema, see updateId above)
                 description: String
                 resultCode: int
                 extendedResultCode: int
                 resultDetails: String
             }
         ]
     }
 }

Parameters:: deviceId - Device identifier in Azure IoT Hub.; moduleId - Device module identifier in Azure IoT Hub.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the device module properties and latest deployment status for a device module connected to Device Update for IoT Hub along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getUpdateComplianceWithResponse
```
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getUpdateComplianceWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)
```
Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.
Query Parameters
Query Parameters
Name Type Required Description

apiVersion String Yes Api Version

Response Body Schema
```
 {
     totalDeviceCount: int
     onLatestUpdateDeviceCount: int
     newUpdatesAvailableDeviceCount: int
     updatesInProgressDeviceCount: int
 }
 
```
Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

listDeviceTags
```
public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listDeviceTags(com.azure.core.http.rest.RequestOptions requestOptions)
```
Gets a list of available group device tags for all devices connected to Device Update for IoT Hub.
Query Parameters
Query Parameters
Name Type Required Description

apiVersion String Yes Api Version

Response Body Schema
```
 {
     value: [
         {
             tagName: String
             deviceCount: int
         }
     ]
     nextLink: String
 }
 
```
Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a list of available group device tags for all devices connected to Device Update for IoT Hub.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getDeviceTagWithResponse
```
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getDeviceTagWithResponse(String tagName,
                                                                                                        com.azure.core.http.rest.RequestOptions requestOptions)
```
Gets a count of how many devices have a device tag.
Query Parameters
Query Parameters
Name Type Required Description

apiVersion String Yes Api Version

Response Body Schema
```
 {
     tagName: String
     deviceCount: int
 }
 
```
Parameters:

tagName - Tag name.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a count of how many devices have a device tag along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

listGroups

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listGroups(com.azure.core.http.rest.RequestOptions requestOptions)

Gets a list of all device groups.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     value: [
         {
             groupId: String
             groupType: String(DeviceClassIdAndIoTHubTag/InvalidDeviceClassIdAndIoTHubTag/DefaultDeviceClassId)
             tags: [
                 String
             ]
             createdDateTime: String
             deviceCount: Integer
             deploymentId: String
             deviceClassId: String
         }
     ]
     nextLink: String
 }

Parameters:: requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: a list of all device groups.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getGroupWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getGroupWithResponse(String groupId,
                                                                                                    com.azure.core.http.rest.RequestOptions requestOptions)

Gets the properties of a group.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     groupId: String
     groupType: String(DeviceClassIdAndIoTHubTag/InvalidDeviceClassIdAndIoTHubTag/DefaultDeviceClassId)
     tags: [
         String
     ]
     createdDateTime: String
     deviceCount: Integer
     deploymentId: String
     deviceClassId: String
 }

Parameters:: groupId - Group identity.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the properties of a group along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

createOrUpdateGroupWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> createOrUpdateGroupWithResponse(String groupId,
                                                                                                               com.azure.core.util.BinaryData group,
                                                                                                               com.azure.core.http.rest.RequestOptions requestOptions)

Create or update a device group.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Request Body Schema


 {
     groupId: String
     groupType: String(DeviceClassIdAndIoTHubTag/InvalidDeviceClassIdAndIoTHubTag/DefaultDeviceClassId)
     tags: [
         String
     ]
     createdDateTime: String
     deviceCount: Integer
     deploymentId: String
     deviceClassId: String
 }

Response Body Schema


 {
     groupId: String
     groupType: String(DeviceClassIdAndIoTHubTag/InvalidDeviceClassIdAndIoTHubTag/DefaultDeviceClassId)
     tags: [
         String
     ]
     createdDateTime: String
     deviceCount: Integer
     deploymentId: String
     deviceClassId: String
 }

Parameters:: groupId - Group identity.; group - The group properties.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: group details along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

deleteGroupWithResponse
```
public Mono<com.azure.core.http.rest.Response<Void>> deleteGroupWithResponse(String groupId,
                                                                             com.azure.core.http.rest.RequestOptions requestOptions)
```
Deletes a device group.
Query Parameters
Query Parameters
Name Type Required Description

apiVersion String Yes Api Version

Parameters:

groupId - Group identity.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getGroupUpdateComplianceWithResponse
```
public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getGroupUpdateComplianceWithResponse(String groupId,
                                                                                                                    com.azure.core.http.rest.RequestOptions requestOptions)
```
Get 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.
Query Parameters
Query Parameters
Name Type Required Description

apiVersion String Yes Api Version

Response Body Schema
```
 {
     totalDeviceCount: int
     onLatestUpdateDeviceCount: int
     newUpdatesAvailableDeviceCount: int
     updatesInProgressDeviceCount: int
 }
 
```
Parameters:

groupId - Group identity.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

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 along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

listBestUpdatesForGroup

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listBestUpdatesForGroup(String groupId,
                                                                                                  com.azure.core.http.rest.RequestOptions requestOptions)

Get the best available updates for a group and a count of how many devices need each update.

Query Parameters

Query Parameters
Name	Type	Required	Description
filter	String	No	Restricts the set of bestUpdates returned. You can filter on update Provider, Name and Version property.
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     value: [
         {
             updateId: {
                 provider: String
                 name: String
                 version: String
             }
             deviceCount: int
         }
     ]
     nextLink: String
 }

Parameters:: groupId - Group identity.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the best available updates for a group and a count of how many devices need each update.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

listDeploymentsForGroup

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listDeploymentsForGroup(String groupId,
                                                                                                  com.azure.core.http.rest.RequestOptions requestOptions)

Gets a list of deployments for a group.

Query Parameters

Query Parameters
Name	Type	Required	Description
filter	String	No	Restricts the set of deployments returned. You can filter on update Provider, Name and Version property.
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     value: [
         {
             deploymentId: String
             startDateTime: String
             updateId: {
                 provider: String
                 name: String
                 version: String
             }
             groupId: String
             isCanceled: Boolean
             isRetried: Boolean
         }
     ]
     nextLink: String
 }

Parameters:: groupId - Group identity.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: a list of deployments for a group.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getDeploymentWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getDeploymentWithResponse(String groupId,
                                                                                                         String deploymentId,
                                                                                                         com.azure.core.http.rest.RequestOptions requestOptions)

Gets the properties of a deployment.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     deploymentId: String
     startDateTime: String
     updateId: {
         provider: String
         name: String
         version: String
     }
     groupId: String
     isCanceled: Boolean
     isRetried: Boolean
 }

Parameters:: groupId - Group identity.; deploymentId - Deployment identifier.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the properties of a deployment along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

createOrUpdateDeploymentWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> createOrUpdateDeploymentWithResponse(String deploymentId,
                                                                                                                    String groupId,
                                                                                                                    com.azure.core.util.BinaryData deployment,
                                                                                                                    com.azure.core.http.rest.RequestOptions requestOptions)

Creates or updates a deployment.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Request Body Schema


 {
     deploymentId: String
     startDateTime: String
     updateId: {
         provider: String
         name: String
         version: String
     }
     groupId: String
     isCanceled: Boolean
     isRetried: Boolean
 }

Response Body Schema


 {
     deploymentId: String
     startDateTime: String
     updateId: {
         provider: String
         name: String
         version: String
     }
     groupId: String
     isCanceled: Boolean
     isRetried: Boolean
 }

Parameters:: deploymentId - Deployment identifier.; groupId - Group identity.; deployment - The deployment properties.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: deployment metadata along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

deleteDeploymentWithResponse
```
public Mono<com.azure.core.http.rest.Response<Void>> deleteDeploymentWithResponse(String groupId,
                                                                                  String deploymentId,
                                                                                  com.azure.core.http.rest.RequestOptions requestOptions)
```
Deletes a deployment.
Query Parameters
Query Parameters
Name Type Required Description

apiVersion String Yes Api Version

Parameters:

groupId - Group identity.

deploymentId - Deployment identifier.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getDeploymentStatusWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getDeploymentStatusWithResponse(String groupId,
                                                                                                               String deploymentId,
                                                                                                               com.azure.core.http.rest.RequestOptions requestOptions)

Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     deploymentState: String(Active/Inactive/Canceled)
     totalDevices: Integer
     devicesInProgressCount: Integer
     devicesCompletedFailedCount: Integer
     devicesCompletedSucceededCount: Integer
     devicesCanceledCount: Integer
 }

Parameters:: groupId - Group identity.; deploymentId - Deployment identifier.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

listDeploymentDevices

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listDeploymentDevices(String groupId,
                                                                                                String deploymentId,
                                                                                                com.azure.core.http.rest.RequestOptions requestOptions)

Gets a list of devices in a deployment along with their state. Useful for getting a list of failed devices.

Query Parameters

Query Parameters
Name	Type	Required	Description
filter	String	No	Restricts the set of deployment device states returned. You can filter on deviceId and moduleId and/or deviceState.
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     value: [
         {
             deviceId: String
             moduleId: String
             retryCount: int
             movedOnToNewDeployment: boolean
             deviceState: String(Succeeded/InProgress/Failed/Canceled/Incompatible)
         }
     ]
     nextLink: String
 }

Parameters:: groupId - Group identity.; deploymentId - Deployment identifier.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: a list of devices in a deployment along with their state.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getOperationWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getOperationWithResponse(String operationId,
                                                                                                        com.azure.core.http.rest.RequestOptions requestOptions)

Retrieve operation status.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Header Parameters

Header Parameters
Name	Type	Required	Description
ifNoneMatch	String	No	Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.

Response Body Schema


 {
     operationId: String
     status: String(Undefined/NotStarted/Running/Succeeded/Failed)
     error: {
         code: String
         message: String
         target: String
         details: [
             (recursive schema, see above)
         ]
         innererror: {
             code: String
             message: String
             errorDetail: String
             innerError: (recursive schema, see innerError above)
         }
         occurredDateTime: String
     }
     traceId: String
     lastActionDateTime: String
     createdDateTime: String
     etag: String
 }

Parameters:: operationId - Operation identifier.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: operation metadata along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

listOperations

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listOperations(com.azure.core.http.rest.RequestOptions requestOptions)

Get a list of all device import operations. Completed operations are kept for 7 days before auto-deleted.

Query Parameters

Query Parameters
Name	Type	Required	Description
filter	String	No	Restricts the set of operations returned. Only one specific filter is supported: "status eq 'NotStarted' or status eq 'Running'"
top	String	No	Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     value: [
         {
             operationId: String
             status: String(Undefined/NotStarted/Running/Succeeded/Failed)
             error: {
                 code: String
                 message: String
                 target: String
                 details: [
                     (recursive schema, see above)
                 ]
                 innererror: {
                     code: String
                     message: String
                     errorDetail: String
                     innerError: (recursive schema, see innerError above)
                 }
                 occurredDateTime: String
             }
             traceId: String
             lastActionDateTime: String
             createdDateTime: String
             etag: String
         }
     ]
     nextLink: String
 }

Parameters:: requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: a list of all device import operations.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

collectLogsWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> collectLogsWithResponse(String operationId,
                                                                                                       com.azure.core.util.BinaryData logCollectionRequest,
                                                                                                       com.azure.core.http.rest.RequestOptions requestOptions)

Start the device diagnostics log collection operation on specified devices.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Request Body Schema


 {
     operationId: String
     deviceList: [
         {
             deviceId: String
             moduleId: String
         }
     ]
     description: String
     createdDateTime: String
     lastActionDateTime: String
     status: String(Undefined/NotStarted/Running/Succeeded/Failed)
 }

Response Body Schema


 {
     operationId: String
     deviceList: [
         {
             deviceId: String
             moduleId: String
         }
     ]
     description: String
     createdDateTime: String
     lastActionDateTime: String
     status: String(Undefined/NotStarted/Running/Succeeded/Failed)
 }

Parameters:: operationId - Operation identifier.; logCollectionRequest - The deployment properties.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: diagnostics request body along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getLogCollectionOperationWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getLogCollectionOperationWithResponse(String operationId,
                                                                                                                     com.azure.core.http.rest.RequestOptions requestOptions)

Get the device diagnostics log collection operation.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     operationId: String
     deviceList: [
         {
             deviceId: String
             moduleId: String
         }
     ]
     description: String
     createdDateTime: String
     lastActionDateTime: String
     status: String(Undefined/NotStarted/Running/Succeeded/Failed)
 }

Parameters:: operationId - Operation identifier.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: the device diagnostics log collection operation along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

listLogCollectionOperations

public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listLogCollectionOperations(com.azure.core.http.rest.RequestOptions requestOptions)

Get all device diagnostics log collection operations.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     value: [
         {
             operationId: String
             deviceList: [
                 {
                     deviceId: String
                     moduleId: String
                 }
             ]
             description: String
             createdDateTime: String
             lastActionDateTime: String
             status: String(Undefined/NotStarted/Running/Succeeded/Failed)
         }
     ]
     nextLink: String
 }

Parameters:: requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: all device diagnostics log collection operations.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

getLogCollectionOperationDetailedStatusWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getLogCollectionOperationDetailedStatusWithResponse(String operationId,
                                                                                                                                   com.azure.core.http.rest.RequestOptions requestOptions)

Get device diagnostics log collection operation with detailed status.

Query Parameters

Query Parameters
Name	Type	Required	Description
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     operationId: String
     createdDateTime: String
     lastActionDateTime: String
     status: String(Undefined/NotStarted/Running/Succeeded/Failed)
     deviceStatus: [
         {
             deviceId: String
             moduleId: String
             status: String(Undefined/NotStarted/Running/Succeeded/Failed)
             resultCode: String
             extendedResultCode: String
             logLocation: String
         }
     ]
     description: String
 }

Parameters:: operationId - Operation identifier.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: device diagnostics log collection operation with detailed status along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

stopDeploymentWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> stopDeploymentWithResponse(String groupId,
                                                                                                          String deploymentId,
                                                                                                          com.azure.core.http.rest.RequestOptions requestOptions)

Stops a deployment.

Query Parameters

Query Parameters
Name	Type	Required	Description
action	String	Yes	Cancel deployment action.
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     deploymentId: String
     startDateTime: String
     updateId: {
         provider: String
         name: String
         version: String
     }
     groupId: String
     isCanceled: Boolean
     isRetried: Boolean
 }

Parameters:: groupId - Group identity.; deploymentId - Deployment identifier.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: deployment metadata along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

retryDeploymentWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> retryDeploymentWithResponse(String groupId,
                                                                                                           String deploymentId,
                                                                                                           com.azure.core.http.rest.RequestOptions requestOptions)

Retries a deployment with failed devices.

Query Parameters

Query Parameters
Name	Type	Required	Description
action	String	Yes	Retry deployment action.
apiVersion	String	Yes	Api Version

Response Body Schema


 {
     deploymentId: String
     startDateTime: String
     updateId: {
         provider: String
         name: String
         version: String
     }
     groupId: String
     isCanceled: Boolean
     isRetried: Boolean
 }

Parameters:: groupId - Group identity.; deploymentId - Deployment identifier.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: deployment metadata along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

Class DeviceManagementAsyncClient

Method Summary

Methods inherited from class java.lang.Object

Method Detail

listDeviceClasses

getDeviceClassWithResponse

listInstallableUpdatesForDeviceClass

listDevices

importDevicesWithResponse

beginImportDevices

getDeviceWithResponse

getDeviceModuleWithResponse

getUpdateComplianceWithResponse

listDeviceTags

getDeviceTagWithResponse

listGroups

getGroupWithResponse

createOrUpdateGroupWithResponse

deleteGroupWithResponse

getGroupUpdateComplianceWithResponse

listBestUpdatesForGroup

listDeploymentsForGroup

getDeploymentWithResponse

createOrUpdateDeploymentWithResponse

deleteDeploymentWithResponse

getDeploymentStatusWithResponse

listDeploymentDevices

getOperationWithResponse

listOperations

collectLogsWithResponse

getLogCollectionOperationWithResponse

listLogCollectionOperations

getLogCollectionOperationDetailedStatusWithResponse

stopDeploymentWithResponse

retryDeploymentWithResponse