diff --git a/eng/versioning/version_client.txt b/eng/versioning/version_client.txt
index 73c9c09196c0..553b09416c8b 100644
--- a/eng/versioning/version_client.txt
+++ b/eng/versioning/version_client.txt
@@ -149,6 +149,7 @@ com.azure:azure-template-perf;1.0.0-beta.1;1.0.0-beta.1
com.azure:azure-media-videoanalyzer-edge;1.0.0-beta.6;1.0.0-beta.7
com.azure:azure-verticals-agrifood-farming;1.0.0-beta.2;1.0.0-beta.3
com.azure:perf-test-core;1.0.0-beta.1;1.0.0-beta.1
+com.azure:azure-deviceupdate-deviceupdate;1.0.0-beta.1;1.0.0-beta.1
com.microsoft.azure:spring-cloud-azure-appconfiguration-config-web;1.3.0;1.4.0-beta.1
com.microsoft.azure:spring-cloud-azure-appconfiguration-config;1.3.0;1.4.0-beta.1
com.microsoft.azure:spring-cloud-azure-feature-management-web;1.3.0;1.4.0-beta.1
diff --git a/sdk/deviceupdate/azure-deviceupdate-deviceupdate/CHANGELOG.md b/sdk/deviceupdate/azure-deviceupdate-deviceupdate/CHANGELOG.md
new file mode 100644
index 000000000000..f0f749605edf
--- /dev/null
+++ b/sdk/deviceupdate/azure-deviceupdate-deviceupdate/CHANGELOG.md
@@ -0,0 +1,13 @@
+# Release History
+
+## 1.0.0-beta.1 (Unreleased)
+
+- Azure DeviceUpdateClient client library for Java. This package contains Microsoft Azure DeviceUpdateClient client library.
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
diff --git a/sdk/deviceupdate/azure-deviceupdate-deviceupdate/README.md b/sdk/deviceupdate/azure-deviceupdate-deviceupdate/README.md
new file mode 100644
index 000000000000..7e1221a27c95
--- /dev/null
+++ b/sdk/deviceupdate/azure-deviceupdate-deviceupdate/README.md
@@ -0,0 +1,63 @@
+# Azure DeviceUpdateClient client library for Java
+
+Azure DeviceUpdateClient client library for Java.
+
+This package contains Microsoft Azure DeviceUpdateClient client library.
+
+## Documentation
+
+Various documentation is available to help you get started
+
+- [API reference documentation][docs]
+- [Product documentation][product_documentation]
+
+## Getting started
+
+### Prerequisites
+
+- [Java Development Kit (JDK)][jdk] with version 8 or above
+- [Azure Subscription][azure_subscription]
+
+### Adding the package to your product
+
+[//]: # ({x-version-update-start;com.azure:azure-deviceupdate-deviceupdate;current})
+```xml
+
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device classes (unique combinations of device manufacturer and model) for all devices + * connected to Device Update for IoT Hub as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the properties of a device class along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema + * + *
{@code + * { + * friendlyName: String + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param deviceClassPatch The device class json merge patch body. Currently only supports patching friendlyName. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device class metadata along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of installable updates for a device class as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of devices connected to Device Update for IoT Hub as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Request Body Schema + * + *
{@code + * String(Devices/Modules/All) + * }+ * + * @param importType The types of devices to import. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema + * + *
{@code + * String(Devices/Modules/All) + * }+ * + * @param importType The types of devices to import. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the {@link PollerFlux} for polling of long-running operation. + */ + @Generated + @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION) + public PollerFlux
Response Body Schema + * + *
{@code + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * }+ * + * @param deviceId Device identifier in Azure IoT Hub. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device properties and latest deployment status for a device connected to Device Update for IoT Hub + * along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * }+ * + * @param deviceId Device identifier in Azure IoT Hub. + * @param moduleId Device module identifier in Azure IoT Hub. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device module properties and latest deployment status for a device module connected to Device Update + * for IoT Hub along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the breakdown of how many devices are on their latest update, have new updates available, or are in + * progress receiving new updates along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of groups returned. You can order by any combination of groupId, device count, created date, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device groups as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema + * + *
{@code + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device group properties along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return 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 along with {@link Response} on + * successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * deviceClassId: String + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deviceCount: int + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the best available updates for a device group and a count of how many devices need each update as + * paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of deployments returned. You can order by start date. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of deployments for a device group as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the deployment properties along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param deployment The deployment properties. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return deployment metadata along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * groupId: String + * deploymentState: String(Active/ActiveWithSubgroupFailures/Failed/Inactive/Canceled) + * 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: OffsetDateTime + * } + * subgroupStatus: [ + * { + * groupId: String + * deviceClassId: String + * deploymentState: String(Active/Failed/Inactive/Canceled) + * error: (recursive schema, see error above) + * totalDevices: Integer + * devicesInProgressCount: Integer + * devicesCompletedFailedCount: Integer + * devicesCompletedSucceededCount: Integer + * devicesCanceledCount: Integer + * } + * ] + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the status of a deployment including a breakdown of how many devices in the deployment are in progress, + * completed, or failed along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of device class subgroups returned. You can filter on compat properties by name and value. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * groupId: String + * createdDateTime: String + * deviceCount: Integer + * deploymentId: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device class subgroups for the group along with {@link Response} on successful completion of {@link + * Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * groupId: String + * createdDateTime: String + * deviceCount: Integer + * deploymentId: String + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device class subgroup details along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return 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 along with {@link Response} + * on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * groupId: String + * deviceClassId: String + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the best available update for a device class subgroup and a count of how many devices need this update + * along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of deployments returned. You can order by start date. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of deployments for a device class subgroup as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the deployment properties along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return deployment metadata along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return deployment metadata along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * groupId: String + * deviceClassId: String + * deploymentState: String(Active/Failed/Inactive/Canceled) + * 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: OffsetDateTime + * } + * totalDevices: Integer + * devicesInProgressCount: Integer + * devicesCompletedFailedCount: Integer + * devicesCompletedSucceededCount: Integer + * devicesCanceledCount: Integer + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the status of a deployment including a breakdown of how many devices in the deployment are in progress, + * completed, or failed along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceId: String + * moduleId: String + * retryCount: int + * movedOnToNewDeployment: boolean + * deviceState: String(Succeeded/InProgress/Canceled/Failed) + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of devices in a deployment along with their state as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Header Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
If-None-Match | 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 + * + *
{@code + * { + * operationId: String + * status: String(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: OffsetDateTime + * } + * traceId: String + * lastActionDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * }+ * + * @param operationId Operation identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return operation metadata along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
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 | Integer | 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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * operationId: String + * status: String(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: OffsetDateTime + * } + * traceId: String + * lastActionDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device import operations as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Request Body Schema + * + *
{@code + * { + * operationId: String + * deviceList: [ + * { + * deviceId: String + * moduleId: String + * } + * ] + * description: String + * createdDateTime: String + * lastActionDateTime: String + * status: String(NotStarted/Running/Succeeded/Failed) + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * operationId: String + * deviceList: [ + * { + * deviceId: String + * moduleId: String + * } + * ] + * description: String + * createdDateTime: String + * lastActionDateTime: String + * status: String(NotStarted/Running/Succeeded/Failed) + * } + * }+ * + * @param operationId Operation identifier. + * @param logCollectionRequest The deployment properties. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return diagnostics request body along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * operationId: String + * deviceList: [ + * { + * deviceId: String + * moduleId: String + * } + * ] + * description: String + * createdDateTime: String + * lastActionDateTime: String + * status: String(NotStarted/Running/Succeeded/Failed) + * } + * }+ * + * @param operationId Operation identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device diagnostics log collection operation along with {@link Response} on successful completion of + * {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * operationId: String + * deviceList: [ + * { + * deviceId: String + * moduleId: String + * } + * ] + * description: String + * createdDateTime: String + * lastActionDateTime: String + * status: String(NotStarted/Running/Succeeded/Failed) + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return all device diagnostics log collection operations as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema + * + *
{@code + * { + * operationId: String + * createdDateTime: String + * lastActionDateTime: String + * status: String(NotStarted/Running/Succeeded/Failed) + * deviceStatus: [ + * { + * deviceId: String + * moduleId: String + * status: String(NotStarted/Running/Succeeded/Failed) + * resultCode: String + * extendedResultCode: String + * logLocation: String + * } + * ] + * description: String + * } + * }+ * + * @param operationId Operation identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device diagnostics log collection operation with detailed status along with {@link Response} on + * successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceId: String + * moduleId: String + * state: String(healthy/unhealthy) + * digitalTwinModelId: String + * healthChecks: [ + * { + * name: String + * result: String(success/userError) + * } + * ] + * } + * ] + * nextLink: String + * } + * }+ * + * @param filter Filter list by specified properties. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return list of device health along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device classes (unique combinations of device manufacturer and model) for all devices + * connected to Device Update for IoT Hub as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the properties of a device class along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Request Body Schema + * + *
{@code + * { + * friendlyName: String + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param deviceClassPatch The device class json merge patch body. Currently only supports patching friendlyName. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device class metadata along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of installable updates for a device class as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of devices connected to Device Update for IoT Hub as paginated response with {@link + * PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Request Body Schema + * + *
{@code + * String(Devices/Modules/All) + * }+ * + * @param importType The types of devices to import. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the {@link SyncPoller} for polling of long-running operation. + */ + @Generated + @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION) + public SyncPoller
Response Body Schema + * + *
{@code + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * }+ * + * @param deviceId Device identifier in Azure IoT Hub. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device properties and latest deployment status for a device connected to Device Update for IoT Hub + * along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * }+ * + * @param deviceId Device identifier in Azure IoT Hub. + * @param moduleId Device module identifier in Azure IoT Hub. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device module properties and latest deployment status for a device module connected to Device Update + * for IoT Hub along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the breakdown of how many devices are on their latest update, have new updates available, or are in + * progress receiving new updates along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of groups returned. You can order by any combination of groupId, device count, created date, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device groups as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema + * + *
{@code + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device group properties along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return 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 along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * deviceClassId: String + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deviceCount: int + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the best available updates for a device group and a count of how many devices need each update as + * paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of deployments returned. You can order by start date. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of deployments for a device group as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the deployment properties along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Request Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param deployment The deployment properties. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return deployment metadata along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * groupId: String + * deploymentState: String(Active/ActiveWithSubgroupFailures/Failed/Inactive/Canceled) + * 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: OffsetDateTime + * } + * subgroupStatus: [ + * { + * groupId: String + * deviceClassId: String + * deploymentState: String(Active/Failed/Inactive/Canceled) + * error: (recursive schema, see error above) + * totalDevices: Integer + * devicesInProgressCount: Integer + * devicesCompletedFailedCount: Integer + * devicesCompletedSucceededCount: Integer + * devicesCanceledCount: Integer + * } + * ] + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the status of a deployment including a breakdown of how many devices in the deployment are in progress, + * completed, or failed along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of device class subgroups returned. You can filter on compat properties by name and value. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * groupId: String + * createdDateTime: String + * deviceCount: Integer + * deploymentId: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device class subgroups for the group along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * groupId: String + * createdDateTime: String + * deviceCount: Integer + * deploymentId: String + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device class subgroup details along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return 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 along with {@link + * Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * groupId: String + * deviceClassId: String + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the best available update for a device class subgroup and a count of how many devices need this update + * along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of deployments returned. You can order by start date. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of deployments for a device class subgroup as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the deployment properties along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return deployment metadata along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return deployment metadata along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * groupId: String + * deviceClassId: String + * deploymentState: String(Active/Failed/Inactive/Canceled) + * 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: OffsetDateTime + * } + * totalDevices: Integer + * devicesInProgressCount: Integer + * devicesCompletedFailedCount: Integer + * devicesCompletedSucceededCount: Integer + * devicesCanceledCount: Integer + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the status of a deployment including a breakdown of how many devices in the deployment are in progress, + * completed, or failed along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceId: String + * moduleId: String + * retryCount: int + * movedOnToNewDeployment: boolean + * deviceState: String(Succeeded/InProgress/Canceled/Failed) + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of devices in a deployment along with their state as paginated response with {@link + * PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Header Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
If-None-Match | 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 + * + *
{@code + * { + * operationId: String + * status: String(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: OffsetDateTime + * } + * traceId: String + * lastActionDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * }+ * + * @param operationId Operation identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return operation metadata along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
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 | Integer | 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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * operationId: String + * status: String(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: OffsetDateTime + * } + * traceId: String + * lastActionDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device import operations as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Request Body Schema + * + *
{@code + * { + * operationId: String + * deviceList: [ + * { + * deviceId: String + * moduleId: String + * } + * ] + * description: String + * createdDateTime: String + * lastActionDateTime: String + * status: String(NotStarted/Running/Succeeded/Failed) + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * operationId: String + * deviceList: [ + * { + * deviceId: String + * moduleId: String + * } + * ] + * description: String + * createdDateTime: String + * lastActionDateTime: String + * status: String(NotStarted/Running/Succeeded/Failed) + * } + * }+ * + * @param operationId Operation identifier. + * @param logCollectionRequest The deployment properties. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return diagnostics request body along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * operationId: String + * deviceList: [ + * { + * deviceId: String + * moduleId: String + * } + * ] + * description: String + * createdDateTime: String + * lastActionDateTime: String + * status: String(NotStarted/Running/Succeeded/Failed) + * } + * }+ * + * @param operationId Operation identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device diagnostics log collection operation along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * operationId: String + * deviceList: [ + * { + * deviceId: String + * moduleId: String + * } + * ] + * description: String + * createdDateTime: String + * lastActionDateTime: String + * status: String(NotStarted/Running/Succeeded/Failed) + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return all device diagnostics log collection operations as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema + * + *
{@code + * { + * operationId: String + * createdDateTime: String + * lastActionDateTime: String + * status: String(NotStarted/Running/Succeeded/Failed) + * deviceStatus: [ + * { + * deviceId: String + * moduleId: String + * status: String(NotStarted/Running/Succeeded/Failed) + * resultCode: String + * extendedResultCode: String + * logLocation: String + * } + * ] + * description: String + * } + * }+ * + * @param operationId Operation identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device diagnostics log collection operation with detailed status along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceId: String + * moduleId: String + * state: String(healthy/unhealthy) + * digitalTwinModelId: String + * healthChecks: [ + * { + * name: String + * result: String(success/userError) + * } + * ] + * } + * ] + * nextLink: String + * } + * }+ * + * @param filter Filter list by specified properties. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return list of device health along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
search | String | No | Request updates matching a free-text search expression. |
filter | String | No | Filter updates by its properties. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * isDeployable: Boolean + * updateType: String + * installedCriteria: String + * compatibility: [ + * { + * String: String + * } + * ] + * instructions: { + * steps: [ + * { + * type: String(Inline/Reference) + * description: String + * handler: String + * handlerProperties: Object + * files: [ + * String + * ] + * updateId: (recursive schema, see updateId above) + * } + * ] + * } + * referencedBy: [ + * (recursive schema, see above) + * ] + * scanResult: String + * manifestVersion: String + * importedDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all updates that have been imported to Device Update for IoT Hub as paginated response with + * {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Request Body Schema + * + *
{@code + * [ + * { + * importManifest: { + * url: String + * sizeInBytes: long + * hashes: { + * String: String + * } + * } + * friendlyName: String + * files: [ + * { + * filename: String + * url: String + * } + * ] + * } + * ] + * }+ * + * @param updateToImport The update to be imported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema + * + *
{@code + * [ + * { + * importManifest: { + * url: String + * sizeInBytes: long + * hashes: { + * String: String + * } + * } + * friendlyName: String + * files: [ + * { + * filename: String + * url: String + * } + * ] + * } + * ] + * }+ * + * @param updateToImport The update to be imported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the {@link PollerFlux} for polling of long-running operation. + */ + @Generated + @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION) + public PollerFlux
Header Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
If-None-Match | 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 + * + *
{@code + * { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * isDeployable: Boolean + * updateType: String + * installedCriteria: String + * compatibility: [ + * { + * String: String + * } + * ] + * instructions: { + * steps: [ + * { + * type: String(Inline/Reference) + * description: String + * handler: String + * handlerProperties: Object + * files: [ + * String + * ] + * updateId: (recursive schema, see updateId above) + * } + * ] + * } + * referencedBy: [ + * (recursive schema, see above) + * ] + * scanResult: String + * manifestVersion: String + * importedDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * }+ * + * @param provider Update provider. + * @param name Update name. + * @param version Update version. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a specific update version along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * value: [ + * String + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all update providers that have been imported to Device Update for IoT Hub as paginated response + * with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema + * + *
{@code + * { + * value: [ + * String + * ] + * nextLink: String + * } + * }+ * + * @param provider Update provider. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all update names that match the specified provider as paginated response with {@link + * PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Filter updates by its properties. |
Response Body Schema + * + *
{@code + * { + * value: [ + * String + * ] + * nextLink: String + * } + * }+ * + * @param provider Update provider. + * @param name Update name. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all update versions that match the specified provider and name as paginated response with + * {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema + * + *
{@code + * { + * value: [ + * String + * ] + * nextLink: String + * } + * }+ * + * @param provider Update provider. + * @param name Update name. + * @param version Update version. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all update file identifiers for the specified version as paginated response with {@link + * PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Header Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
If-None-Match | 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 + * + *
{@code + * { + * fileName: String + * sizeInBytes: long + * hashes: { + * String: String + * } + * mimeType: String + * scanResult: String + * scanDetails: String + * properties: { + * String: String + * } + * fileId: String + * relatedFiles: [ + * { + * fileName: String + * sizeInBytes: long + * hashes: { + * String: String + * } + * mimeType: String + * scanResult: String + * scanDetails: String + * properties: { + * String: String + * } + * } + * ] + * downloadHandler: { + * id: String + * } + * etag: String + * } + * }+ * + * @param provider Update provider. + * @param name Update name. + * @param version Update version. + * @param fileId File identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a specific update file from the version along with {@link Response} on successful completion of {@link + * Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
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 | Integer | 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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * operationId: String + * status: String(NotStarted/Running/Succeeded/Failed) + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * resourceLocation: String + * 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: OffsetDateTime + * } + * traceId: String + * lastActionDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all import update operations as paginated response with {@link PagedFlux}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Header Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
If-None-Match | 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 + * + *
{@code + * { + * operationId: String + * status: String(NotStarted/Running/Succeeded/Failed) + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * resourceLocation: String + * 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: OffsetDateTime + * } + * traceId: String + * lastActionDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * }+ * + * @param operationId Operation identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return operation metadata along with {@link Response} on successful completion of {@link Mono}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
search | String | No | Request updates matching a free-text search expression. |
filter | String | No | Filter updates by its properties. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * isDeployable: Boolean + * updateType: String + * installedCriteria: String + * compatibility: [ + * { + * String: String + * } + * ] + * instructions: { + * steps: [ + * { + * type: String(Inline/Reference) + * description: String + * handler: String + * handlerProperties: Object + * files: [ + * String + * ] + * updateId: (recursive schema, see updateId above) + * } + * ] + * } + * referencedBy: [ + * (recursive schema, see above) + * ] + * scanResult: String + * manifestVersion: String + * importedDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all updates that have been imported to Device Update for IoT Hub as paginated response with + * {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Request Body Schema + * + *
{@code + * [ + * { + * importManifest: { + * url: String + * sizeInBytes: long + * hashes: { + * String: String + * } + * } + * friendlyName: String + * files: [ + * { + * filename: String + * url: String + * } + * ] + * } + * ] + * }+ * + * @param updateToImport The update to be imported. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the {@link SyncPoller} for polling of long-running operation. + */ + @Generated + @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION) + public SyncPoller
Header Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
If-None-Match | 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 + * + *
{@code + * { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * isDeployable: Boolean + * updateType: String + * installedCriteria: String + * compatibility: [ + * { + * String: String + * } + * ] + * instructions: { + * steps: [ + * { + * type: String(Inline/Reference) + * description: String + * handler: String + * handlerProperties: Object + * files: [ + * String + * ] + * updateId: (recursive schema, see updateId above) + * } + * ] + * } + * referencedBy: [ + * (recursive schema, see above) + * ] + * scanResult: String + * manifestVersion: String + * importedDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * }+ * + * @param provider Update provider. + * @param name Update name. + * @param version Update version. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a specific update version along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * value: [ + * String + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all update providers that have been imported to Device Update for IoT Hub as paginated response + * with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema + * + *
{@code + * { + * value: [ + * String + * ] + * nextLink: String + * } + * }+ * + * @param provider Update provider. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all update names that match the specified provider as paginated response with {@link + * PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Filter updates by its properties. |
Response Body Schema + * + *
{@code + * { + * value: [ + * String + * ] + * nextLink: String + * } + * }+ * + * @param provider Update provider. + * @param name Update name. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all update versions that match the specified provider and name as paginated response with + * {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema + * + *
{@code + * { + * value: [ + * String + * ] + * nextLink: String + * } + * }+ * + * @param provider Update provider. + * @param name Update name. + * @param version Update version. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all update file identifiers for the specified version as paginated response with {@link + * PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Header Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
If-None-Match | 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 + * + *
{@code + * { + * fileName: String + * sizeInBytes: long + * hashes: { + * String: String + * } + * mimeType: String + * scanResult: String + * scanDetails: String + * properties: { + * String: String + * } + * fileId: String + * relatedFiles: [ + * { + * fileName: String + * sizeInBytes: long + * hashes: { + * String: String + * } + * mimeType: String + * scanResult: String + * scanDetails: String + * properties: { + * String: String + * } + * } + * ] + * downloadHandler: { + * id: String + * } + * etag: String + * } + * }+ * + * @param provider Update provider. + * @param name Update name. + * @param version Update version. + * @param fileId File identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a specific update file from the version along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
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 | Integer | 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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * operationId: String + * status: String(NotStarted/Running/Succeeded/Failed) + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * resourceLocation: String + * 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: OffsetDateTime + * } + * traceId: String + * lastActionDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all import update operations as paginated response with {@link PagedIterable}. + */ + @Generated + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Header Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
If-None-Match | 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 + * + *
{@code + * { + * operationId: String + * status: String(NotStarted/Running/Succeeded/Failed) + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * resourceLocation: String + * 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: OffsetDateTime + * } + * traceId: String + * lastActionDateTime: OffsetDateTime + * createdDateTime: OffsetDateTime + * etag: String + * } + * }+ * + * @param operationId Operation identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return operation metadata along with {@link Response}. + */ + @Generated + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device classes (unique combinations of device manufacturer and model) for all devices + * connected to Device Update for IoT Hub along with {@link PagedResponse} on successful completion of {@link + * Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device classes (unique combinations of device manufacturer and model) for all devices + * connected to Device Update for IoT Hub along with {@link PagedResponse} on successful completion of {@link + * Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device classes (unique combinations of device manufacturer and model) for all devices + * connected to Device Update for IoT Hub as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device classes (unique combinations of device manufacturer and model) for all devices + * connected to Device Update for IoT Hub as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device classes (unique combinations of device manufacturer and model) for all devices + * connected to Device Update for IoT Hub as paginated response with {@link PagedIterable}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the properties of a device class along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the properties of a device class along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the properties of a device class along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Request Body Schema + * + *
{@code + * { + * friendlyName: String + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param deviceClassPatch The device class json merge patch body. Currently only supports patching friendlyName. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device class metadata along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema + * + *
{@code + * { + * friendlyName: String + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param deviceClassPatch The device class json merge patch body. Currently only supports patching friendlyName. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device class metadata along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema + * + *
{@code + * { + * friendlyName: String + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * friendlyName: String + * deviceClassProperties: { + * contractModel: { + * id: String + * name: String + * } + * compatProperties: { + * String: String + * } + * } + * bestCompatibleUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param deviceClassPatch The device class json merge patch body. Currently only supports patching friendlyName. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device class metadata along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of installable updates for a device class along with {@link PagedResponse} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of installable updates for a device class along with {@link PagedResponse} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of installable updates for a device class as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of installable updates for a device class as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of installable updates for a device class as paginated response with {@link PagedIterable}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of devices connected to Device Update for IoT Hub along with {@link PagedResponse} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of devices connected to Device Update for IoT Hub along with {@link PagedResponse} on successful + * completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of devices connected to Device Update for IoT Hub as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of devices connected to Device Update for IoT Hub as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of devices returned. You can filter on GroupId, DeviceClassId, or GroupId and DeploymentStatus. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of devices connected to Device Update for IoT Hub as paginated response with {@link + * PagedIterable}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Request Body Schema + * + *
{@code + * String(Devices/Modules/All) + * }+ * + * @param importType The types of devices to import. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema + * + *
{@code + * String(Devices/Modules/All) + * }+ * + * @param importType The types of devices to import. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema + * + *
{@code + * String(Devices/Modules/All) + * }+ * + * @param importType The types of devices to import. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the {@link PollerFlux} for polling of long-running operation. + */ + @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION) + public PollerFlux
Request Body Schema + * + *
{@code + * String(Devices/Modules/All) + * }+ * + * @param importType The types of devices to import. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the {@link PollerFlux} for polling of long-running operation. + */ + @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION) + public PollerFlux
Request Body Schema + * + *
{@code + * String(Devices/Modules/All) + * }+ * + * @param importType The types of devices to import. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the {@link SyncPoller} for polling of long-running operation. + */ + @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION) + public SyncPoller
Response Body Schema + * + *
{@code + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * }+ * + * @param deviceId Device identifier in Azure IoT Hub. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device properties and latest deployment status for a device connected to Device Update for IoT Hub + * along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * }+ * + * @param deviceId Device identifier in Azure IoT Hub. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device properties and latest deployment status for a device connected to Device Update for IoT Hub + * along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * }+ * + * @param deviceId Device identifier in Azure IoT Hub. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device properties and latest deployment status for a device connected to Device Update for IoT Hub + * along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * }+ * + * @param deviceId Device identifier in Azure IoT Hub. + * @param moduleId Device module identifier in Azure IoT Hub. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device module properties and latest deployment status for a device module connected to Device Update + * for IoT Hub along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * }+ * + * @param deviceId Device identifier in Azure IoT Hub. + * @param moduleId Device module identifier in Azure IoT Hub. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device module properties and latest deployment status for a device module connected to Device Update + * for IoT Hub along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deviceId: String + * moduleId: String + * deviceClassId: String + * groupId: String + * lastAttemptedUpdate: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) + * installedUpdate: (recursive schema, see installedUpdate above) + * onLatestUpdate: boolean + * lastDeploymentId: String + * lastInstallResult: { + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * stepResults: [ + * { + * update: (recursive schema, see update above) + * description: String + * resultCode: int + * extendedResultCode: int + * resultDetails: String + * } + * ] + * } + * } + * }+ * + * @param deviceId Device identifier in Azure IoT Hub. + * @param moduleId Device module identifier in Azure IoT Hub. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device module properties and latest deployment status for a device module connected to Device Update + * for IoT Hub along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the breakdown of how many devices are on their latest update, have new updates available, or are in + * progress receiving new updates along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the breakdown of how many devices are on their latest update, have new updates available, or are in + * progress receiving new updates along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the breakdown of how many devices are on their latest update, have new updates available, or are in + * progress receiving new updates along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of groups returned. You can order by any combination of groupId, device count, created date, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device groups along with {@link PagedResponse} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of groups returned. You can order by any combination of groupId, device count, created date, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device groups along with {@link PagedResponse} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of groups returned. You can order by any combination of groupId, device count, created date, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device groups as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of groups returned. You can order by any combination of groupId, device count, created date, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device groups as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of groups returned. You can order by any combination of groupId, device count, created date, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * ] + * nextLink: String + * } + * }+ * + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of all device groups as paginated response with {@link PagedIterable}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema + * + *
{@code + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device group properties along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device group properties along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * groupId: String + * groupType: String(IoTHubTag/DefaultNoTag) + * createdDateTime: String + * deviceCount: Integer + * subgroupsWithNewUpdatesAvailableCount: Integer + * subgroupsWithUpdatesInProgressCount: Integer + * subgroupsWithOnLatestUpdateCount: Integer + * deployments: [ + * String + * ] + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device group properties along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return 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 along with {@link Response} on + * successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return 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 along with {@link Response} on + * successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return 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 along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * deviceClassId: String + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deviceCount: int + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the best available updates for a device group and a count of how many devices need each update along with + * {@link PagedResponse} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * deviceClassId: String + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deviceCount: int + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the best available updates for a device group and a count of how many devices need each update along with + * {@link PagedResponse} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * deviceClassId: String + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deviceCount: int + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the best available updates for a device group and a count of how many devices need each update as + * paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * deviceClassId: String + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deviceCount: int + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the best available updates for a device group and a count of how many devices need each update as + * paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
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. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * groupId: String + * deviceClassId: String + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deviceCount: int + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the best available updates for a device group and a count of how many devices need each update as + * paginated response with {@link PagedIterable}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of deployments returned. You can order by start date. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of deployments for a device group along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of deployments returned. You can order by start date. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of deployments for a device group along with {@link PagedResponse} on successful completion of + * {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of deployments returned. You can order by start date. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of deployments for a device group as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of deployments returned. You can order by start date. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of deployments for a device group as paginated response with {@link PagedFlux}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedFlux
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
orderby | String | No | Orders the set of deployments returned. You can order by start date. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return a list of deployments for a device group as paginated response with {@link PagedIterable}. + */ + @ServiceMethod(returns = ReturnType.COLLECTION) + public PagedIterable
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the deployment properties along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the deployment properties along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the deployment properties along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Request Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param deployment The deployment properties. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return deployment metadata along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param deployment The deployment properties. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return deployment metadata along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Request Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + *
Response Body Schema + * + *
{@code + * { + * deploymentId: String + * startDateTime: OffsetDateTime + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * groupId: String + * deviceClassSubgroups: [ + * String + * ] + * isCanceled: Boolean + * isRetried: Boolean + * rollbackPolicy: { + * update: (recursive schema, see update above) + * failure: { + * devicesFailedPercentage: int + * devicesFailedCount: int + * } + * } + * isCloudInitiatedRollback: Boolean + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param deployment The deployment properties. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return deployment metadata along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * groupId: String + * deploymentState: String(Active/ActiveWithSubgroupFailures/Failed/Inactive/Canceled) + * 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: OffsetDateTime + * } + * subgroupStatus: [ + * { + * groupId: String + * deviceClassId: String + * deploymentState: String(Active/Failed/Inactive/Canceled) + * error: (recursive schema, see error above) + * totalDevices: Integer + * devicesInProgressCount: Integer + * devicesCompletedFailedCount: Integer + * devicesCompletedSucceededCount: Integer + * devicesCanceledCount: Integer + * } + * ] + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the status of a deployment including a breakdown of how many devices in the deployment are in progress, + * completed, or failed along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * groupId: String + * deploymentState: String(Active/ActiveWithSubgroupFailures/Failed/Inactive/Canceled) + * 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: OffsetDateTime + * } + * subgroupStatus: [ + * { + * groupId: String + * deviceClassId: String + * deploymentState: String(Active/Failed/Inactive/Canceled) + * error: (recursive schema, see error above) + * totalDevices: Integer + * devicesInProgressCount: Integer + * devicesCompletedFailedCount: Integer + * devicesCompletedSucceededCount: Integer + * devicesCanceledCount: Integer + * } + * ] + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the status of a deployment including a breakdown of how many devices in the deployment are in progress, + * completed, or failed along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * groupId: String + * deploymentState: String(Active/ActiveWithSubgroupFailures/Failed/Inactive/Canceled) + * 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: OffsetDateTime + * } + * subgroupStatus: [ + * { + * groupId: String + * deviceClassId: String + * deploymentState: String(Active/Failed/Inactive/Canceled) + * error: (recursive schema, see error above) + * totalDevices: Integer + * devicesInProgressCount: Integer + * devicesCompletedFailedCount: Integer + * devicesCompletedSucceededCount: Integer + * devicesCanceledCount: Integer + * } + * ] + * } + * }+ * + * @param groupId Group identity. + * @param deploymentId Deployment identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the status of a deployment including a breakdown of how many devices in the deployment are in progress, + * completed, or failed along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of device class subgroups returned. You can filter on compat properties by name and value. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * groupId: String + * createdDateTime: String + * deviceCount: Integer + * deploymentId: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device class subgroups for the group along with {@link Response} on successful completion of {@link + * Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of device class subgroups returned. You can filter on compat properties by name and value. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * groupId: String + * createdDateTime: String + * deviceCount: Integer + * deploymentId: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device class subgroups for the group along with {@link Response} on successful completion of {@link + * Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Query Parameters + * + *
Name | Type | Required | Description |
---|---|---|---|
filter | String | No | Restricts the set of device class subgroups returned. You can filter on compat properties by name and value. |
Response Body Schema + * + *
{@code + * { + * value: [ + * { + * deviceClassId: String + * groupId: String + * createdDateTime: String + * deviceCount: Integer + * deploymentId: String + * } + * ] + * nextLink: String + * } + * }+ * + * @param groupId Group identity. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the device class subgroups for the group along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * groupId: String + * createdDateTime: String + * deviceCount: Integer + * deploymentId: String + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device class subgroup details along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * groupId: String + * createdDateTime: String + * deviceCount: Integer + * deploymentId: String + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device class subgroup details along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * deviceClassId: String + * groupId: String + * createdDateTime: String + * deviceCount: Integer + * deploymentId: String + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return device class subgroup details along with {@link Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return 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 along with {@link Response} + * on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return 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 along with {@link Response} + * on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * totalDeviceCount: int + * onLatestUpdateDeviceCount: int + * newUpdatesAvailableDeviceCount: int + * updatesInProgressDeviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return 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 along with {@link + * Response}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Response
Response Body Schema + * + *
{@code + * { + * groupId: String + * deviceClassId: String + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the best available update for a device class subgroup and a count of how many devices need this update + * along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono
Response Body Schema + * + *
{@code + * { + * groupId: String + * deviceClassId: String + * update: { + * updateId: { + * provider: String + * name: String + * version: String + * } + * description: String + * friendlyName: String + * } + * deviceCount: int + * } + * }+ * + * @param groupId Group identity. + * @param deviceClassId Device class identifier. + * @param requestOptions The options to configure the HTTP request before HTTP client sends it. + * @param context The context to associate with this operation. + * @throws HttpResponseException thrown if the request is rejected by server. + * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401. + * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404. + * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409. + * @return the best available update for a device class subgroup and a count of how many devices need this update + * along with {@link Response} on successful completion of {@link Mono}. + */ + @ServiceMethod(returns = ReturnType.SINGLE) + public Mono