public final class DevicesAsyncClient extends Object
Modifier and Type | Method and Description |
---|---|
Mono<Group> |
createOrUpdateGroup(String groupId,
Group group)
Create or update a device group.
|
Mono<com.azure.core.http.rest.Response<Group>> |
createOrUpdateGroupWithResponse(String groupId,
Group group)
Create or update a device group.
|
Mono<Void> |
deleteGroup(String groupId)
Deletes a device group.
|
Mono<com.azure.core.http.rest.Response<Void>> |
deleteGroupWithResponse(String groupId)
Deletes a device group.
|
com.azure.core.http.rest.PagedFlux<DeviceClass> |
getAllDeviceClasses()
Gets a list of all device classes (unique combinations of device manufacturer and model) for all devices
connected to Device Update for IoT Hub.
|
Mono<com.azure.core.http.rest.PagedResponse<DeviceClass>> |
getAllDeviceClassesNextSinglePage(String nextLink)
Get the next page of items.
|
Mono<com.azure.core.http.rest.PagedResponse<DeviceClass>> |
getAllDeviceClassesSinglePage()
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<Device> |
getAllDevices(String filter)
Gets a list of devices connected to Device Update for IoT Hub.
|
Mono<com.azure.core.http.rest.PagedResponse<Device>> |
getAllDevicesNextSinglePage(String nextLink)
Get the next page of items.
|
Mono<com.azure.core.http.rest.PagedResponse<Device>> |
getAllDevicesSinglePage(String filter)
Gets a list of devices connected to Device Update for IoT Hub.
|
com.azure.core.http.rest.PagedFlux<DeviceTag> |
getAllDeviceTags()
Gets a list of available group device tags for all devices connected to Device Update for IoT Hub.
|
Mono<com.azure.core.http.rest.PagedResponse<DeviceTag>> |
getAllDeviceTagsNextSinglePage(String nextLink)
Get the next page of items.
|
Mono<com.azure.core.http.rest.PagedResponse<DeviceTag>> |
getAllDeviceTagsSinglePage()
Gets a list of available group device tags for all devices connected to Device Update for IoT Hub.
|
com.azure.core.http.rest.PagedFlux<Group> |
getAllGroups()
Gets a list of all device groups.
|
Mono<com.azure.core.http.rest.PagedResponse<Group>> |
getAllGroupsNextSinglePage(String nextLink)
Get the next page of items.
|
Mono<com.azure.core.http.rest.PagedResponse<Group>> |
getAllGroupsSinglePage()
Gets a list of all device groups.
|
Mono<Device> |
getDevice(String deviceId)
Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.
|
Mono<DeviceClass> |
getDeviceClass(String deviceClassId)
Gets the properties of a device class.
|
com.azure.core.http.rest.PagedFlux<String> |
getDeviceClassDeviceIds(String deviceClassId)
Gets a list of device identifiers in a device class.
|
Mono<com.azure.core.http.rest.PagedResponse<String>> |
getDeviceClassDeviceIdsNextSinglePage(String nextLink)
Get the next page of items.
|
Mono<com.azure.core.http.rest.PagedResponse<String>> |
getDeviceClassDeviceIdsSinglePage(String deviceClassId)
Gets a list of device identifiers in a device class.
|
com.azure.core.http.rest.PagedFlux<UpdateId> |
getDeviceClassInstallableUpdates(String deviceClassId)
Gets a list of installable updates for a device class.
|
Mono<com.azure.core.http.rest.PagedResponse<UpdateId>> |
getDeviceClassInstallableUpdatesNextSinglePage(String nextLink)
Get the next page of items.
|
Mono<com.azure.core.http.rest.PagedResponse<UpdateId>> |
getDeviceClassInstallableUpdatesSinglePage(String deviceClassId)
Gets a list of installable updates for a device class.
|
Mono<com.azure.core.http.rest.Response<DeviceClass>> |
getDeviceClassWithResponse(String deviceClassId)
Gets the properties of a device class.
|
Mono<DeviceTag> |
getDeviceTag(String tagName)
Gets a count of how many devices have a device tag.
|
Mono<com.azure.core.http.rest.Response<DeviceTag>> |
getDeviceTagWithResponse(String tagName)
Gets a count of how many devices have a device tag.
|
Mono<com.azure.core.http.rest.Response<Device>> |
getDeviceWithResponse(String deviceId)
Gets the device properties and latest deployment status for a device connected to Device Update for IoT Hub.
|
Mono<Group> |
getGroup(String groupId)
Gets the properties of a group.
|
com.azure.core.http.rest.PagedFlux<UpdatableDevices> |
getGroupBestUpdates(String groupId,
String filter)
Get the best available updates for a group and a count of how many devices need each update.
|
Mono<com.azure.core.http.rest.PagedResponse<UpdatableDevices>> |
getGroupBestUpdatesNextSinglePage(String nextLink)
Get the next page of items.
|
Mono<com.azure.core.http.rest.PagedResponse<UpdatableDevices>> |
getGroupBestUpdatesSinglePage(String groupId,
String filter)
Get the best available updates for a group and a count of how many devices need each update.
|
Mono<UpdateCompliance> |
getGroupUpdateCompliance(String groupId)
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<UpdateCompliance>> |
getGroupUpdateComplianceWithResponse(String groupId)
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<Group>> |
getGroupWithResponse(String groupId)
Gets the properties of a group.
|
Mono<UpdateCompliance> |
getUpdateCompliance()
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<UpdateCompliance>> |
getUpdateComplianceWithResponse()
Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress
receiving new updates.
|
public Mono<com.azure.core.http.rest.PagedResponse<DeviceClass>> getAllDeviceClassesSinglePage()
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public com.azure.core.http.rest.PagedFlux<DeviceClass> getAllDeviceClasses()
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.Response<DeviceClass>> getDeviceClassWithResponse(String deviceClassId)
deviceClassId
- Device class identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<DeviceClass> getDeviceClass(String deviceClassId)
deviceClassId
- Device class identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<String>> getDeviceClassDeviceIdsSinglePage(String deviceClassId)
deviceClassId
- Device class identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public com.azure.core.http.rest.PagedFlux<String> getDeviceClassDeviceIds(String deviceClassId)
deviceClassId
- Device class identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<UpdateId>> getDeviceClassInstallableUpdatesSinglePage(String deviceClassId)
deviceClassId
- Device class identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public com.azure.core.http.rest.PagedFlux<UpdateId> getDeviceClassInstallableUpdates(String deviceClassId)
deviceClassId
- Device class identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<Device>> getAllDevicesSinglePage(String filter)
filter
- Restricts the set of devices returned. You can only filter on device GroupId.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public com.azure.core.http.rest.PagedFlux<Device> getAllDevices(String filter)
filter
- Restricts the set of devices returned. You can only filter on device GroupId.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.Response<Device>> getDeviceWithResponse(String deviceId)
deviceId
- Device identifier in Azure IOT Hub.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<Device> getDevice(String deviceId)
deviceId
- Device identifier in Azure IOT Hub.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.Response<UpdateCompliance>> getUpdateComplianceWithResponse()
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<UpdateCompliance> getUpdateCompliance()
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<DeviceTag>> getAllDeviceTagsSinglePage()
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public com.azure.core.http.rest.PagedFlux<DeviceTag> getAllDeviceTags()
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.Response<DeviceTag>> getDeviceTagWithResponse(String tagName)
tagName
- Tag name.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<DeviceTag> getDeviceTag(String tagName)
tagName
- Tag name.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<Group>> getAllGroupsSinglePage()
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public com.azure.core.http.rest.PagedFlux<Group> getAllGroups()
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.Response<Group>> getGroupWithResponse(String groupId)
groupId
- Group identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<Group> getGroup(String groupId)
groupId
- Group identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.Response<Group>> createOrUpdateGroupWithResponse(String groupId, Group group)
groupId
- Group identifier.group
- The group properties.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<Group> createOrUpdateGroup(String groupId, Group group)
groupId
- Group identifier.group
- The group properties.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.Response<Void>> deleteGroupWithResponse(String groupId)
groupId
- Group identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<Void> deleteGroup(String groupId)
groupId
- Group identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.Response<UpdateCompliance>> getGroupUpdateComplianceWithResponse(String groupId)
groupId
- Group identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<UpdateCompliance> getGroupUpdateCompliance(String groupId)
groupId
- Group identifier.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<UpdatableDevices>> getGroupBestUpdatesSinglePage(String groupId, String filter)
groupId
- Group identifier.filter
- Restricts the set of bestUpdates returned. You can filter on update Provider, Name and Version
property.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public com.azure.core.http.rest.PagedFlux<UpdatableDevices> getGroupBestUpdates(String groupId, String filter)
groupId
- Group identifier.filter
- Restricts the set of bestUpdates returned. You can filter on update Provider, Name and Version
property.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<DeviceClass>> getAllDeviceClassesNextSinglePage(String nextLink)
nextLink
- The nextLink parameter.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<String>> getDeviceClassDeviceIdsNextSinglePage(String nextLink)
nextLink
- The nextLink parameter.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<UpdateId>> getDeviceClassInstallableUpdatesNextSinglePage(String nextLink)
nextLink
- The nextLink parameter.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<Device>> getAllDevicesNextSinglePage(String nextLink)
nextLink
- The nextLink parameter.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<DeviceTag>> getAllDeviceTagsNextSinglePage(String nextLink)
nextLink
- The nextLink parameter.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<Group>> getAllGroupsNextSinglePage(String nextLink)
nextLink
- The nextLink parameter.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Mono<com.azure.core.http.rest.PagedResponse<UpdatableDevices>> getGroupBestUpdatesNextSinglePage(String nextLink)
nextLink
- The nextLink parameter.IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.Copyright © 2021 Microsoft Corporation. All rights reserved.