The prior GA library ({@code azure-iot-deviceupdate} 1.0.x) shipped these protocol LRO overloads
+ * with a final-result type of {@code BinaryData}. After migrating to TypeSpec, the emitter derives the
+ * final-result type as {@code Void} (the delete operation has an empty {@code 204} response), which is a
+ * binary breaking change: {@code SyncPoller
This cannot be expressed in {@code client.tsp}/{@code tspconfig.yaml}, so this customization restores the + * final-result type to {@code BinaryData} on the public sync/async clients and on the underlying implementation + * client (both the method return type and the poller's final-result {@link com.azure.core.util.serializer.TypeReference}).
+ */ +public class DeviceUpdateCustomization extends Customization { + + private static final String ROOT_PACKAGE = "com.azure.iot.deviceupdate"; + private static final String IMPL_PACKAGE = "com.azure.iot.deviceupdate.implementation"; + + @Override + public void customize(LibraryCustomization libraryCustomization, Logger logger) { + logger.info("Restoring 'beginDeleteUpdate' protocol overload final-result type to BinaryData for backward compatibility."); + + // Public clients: only the method return type needs to change; the body simply delegates to the + // implementation client, whose return type is retyped below. + restoreBinaryDataFinalResult(libraryCustomization.getClass(ROOT_PACKAGE, "DeviceUpdateClient"), + "beginDeleteUpdate", false); + restoreBinaryDataFinalResult(libraryCustomization.getClass(ROOT_PACKAGE, "DeviceUpdateAsyncClient"), + "beginDeleteUpdate", false); + + // Implementation client: retype the method and rewrite the poller's final-result TypeReference. + ClassCustomization impl = libraryCustomization.getClass(IMPL_PACKAGE, "DeviceUpdateClientImpl"); + restoreBinaryDataFinalResult(impl, "beginDeleteUpdate", true); + restoreBinaryDataFinalResult(impl, "beginDeleteUpdateAsync", true); + } + + /** + * Retypes the protocol overload of {@code methodName} from {@codeQuery Parameters - * + * Gets a list of all device classes (sets of devices compatible with the same + * updates based on the model Id and compat properties reported in the Device + * Update PnP interface in IoT Hub) for all devices connected to Device Update for + * IoT Hub. + *
Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| filter | String | No | Restricts the set of device classes returned. You can filter on friendly name. |
| Name | Type | Required | Description |
| filter | String | No | Restricts the set of device classes returned. You can filter on + * friendly name. |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deviceClassId: String (Required)
- * friendlyName: String (Optional)
- * deviceClassProperties (Required): {
- * contractModel (Optional): {
- * id: String (Required)
- * name: String (Required)
- * }
- * compatProperties (Required): {
- * String: String (Required)
- * }
- * }
- * bestCompatibleUpdate (Optional): {
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * }
+ * deviceClassId: String (Required)
+ * friendlyName: String (Optional)
+ * deviceClassProperties (Required): {
+ * contractModel (Optional): {
+ * id: String (Required)
+ * name: String (Required)
* }
- * ]
- * nextLink: String (Optional)
+ * compatProperties (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * bestCompatibleUpdate (Optional): {
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
+ * }
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
* }
- * }
- *
+ * }
+ *
+ *
* @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 (sets of devices compatible with the same updates based on the model Id and
- * compat properties reported in the Device Update PnP interface in IoT Hub) for all devices connected to Device
- * Update for IoT Hub as paginated response with {@link PagedFlux}.
+ * @return a list of all device classes (sets of devices compatible with the same
+ * updates based on the model Id and compat properties reported in the Device
+ * Update PnP interface in IoT Hub) for all devices connected to Device Update for
+ * IoT Hub as paginated response with {@link PagedFlux}.
*/
@Generated
@ServiceMethod(returns = ReturnType.COLLECTION)
@@ -100,10 +122,10 @@ public PagedFluxResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deviceClassId: String (Required)
* friendlyName: String (Optional)
@@ -126,8 +148,9 @@ public PagedFlux listDeviceClasses(RequestOptions requestOptions) {
* friendlyName: String (Optional)
* }
* }
- * }
- *
+ * }
+ *
+ *
* @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.
@@ -144,18 +167,20 @@ public MonoRequest Body Schema - * - *
{@code
+ * Request Body Schema
+ *
+ *
+ * {@code
* {
- * friendlyName: String (Required)
+ * friendlyName: String (Optional, Required on create)
* }
- * }
- *
- * Response Body Schema
- *
- *
{@code
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deviceClassId: String (Required)
* friendlyName: String (Optional)
@@ -178,10 +203,12 @@ public Mono> getDeviceClassWithResponse(String deviceClassI
* friendlyName: String (Optional)
* }
* }
- * }
- *
+ * }
+ *
+ *
* @param deviceClassId Device class identifier.
- * @param deviceClassPatch The device class json merge patch body. Currently only supports patching friendlyName.
+ * @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.
@@ -197,12 +224,14 @@ public MonoResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * }
- * ]
- * nextLink: String (Optional)
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
+ * }
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @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.
@@ -256,60 +281,56 @@ public PagedFluxQuery Parameters - * + *
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. Use DeploymentStatus eq null to query for devices with no deployment status (that have never been deployed to). |
| Name | Type | Required | Description |
| filter | String | No | Restricts the set of devices returned. You can filter on + * GroupId, + * DeviceClassId, or GroupId and DeploymentStatus. Use DeploymentStatus eq null to + * query for devices with no deployment status (that have never been deployed to). |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deviceId: String (Required)
- * moduleId: String (Optional)
- * deviceClassId: String (Required)
- * groupId: String (Optional)
- * lastAttemptedUpdate (Optional): {
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
+ * deviceId: String (Required)
+ * moduleId: String (Optional)
+ * deviceClassId: String (Required)
+ * groupId: String (Optional)
+ * lastAttemptedUpdate (Optional): {
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
+ * }
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
+ * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) (Optional)
+ * installedUpdate (Optional): (recursive schema, see installedUpdate above)
+ * onLatestUpdate: boolean (Required)
+ * lastDeploymentId: String (Optional)
+ * lastInstallResult (Optional): {
+ * resultCode: int (Required)
+ * extendedResultCode: int (Required)
+ * resultDetails: String (Optional)
+ * stepResults (Optional): [
+ * (Optional){
+ * update (Optional): (recursive schema, see update above)
* description: String (Optional)
- * friendlyName: String (Optional)
- * }
- * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) (Optional)
- * installedUpdate (Optional): (recursive schema, see installedUpdate above)
- * onLatestUpdate: boolean (Required)
- * lastDeploymentId: String (Optional)
- * lastInstallResult (Optional): {
* resultCode: int (Required)
* extendedResultCode: int (Required)
* resultDetails: String (Optional)
- * stepResults (Optional): [
- * (Optional){
- * update (Optional): (recursive schema, see update above)
- * description: String (Optional)
- * resultCode: int (Required)
- * extendedResultCode: int (Required)
- * resultDetails: String (Optional)
- * }
- * ]
* }
- * }
- * ]
- * nextLink: String (Optional)
+ * ]
+ * }
+ * }
* }
- * }
- *
+ *
+ *
* @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.
@@ -324,15 +345,16 @@ public PagedFluxRequest Body Schema - * - *
{@code
+ * Import existing devices from IoT Hub. This is a long-running-operation; use
+ * Operation-Location response header value to check for operation status.
+ * 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.
@@ -348,11 +370,12 @@ public PollerFluxResponse Body Schema - * - *
{@code
+ * Gets the device properties and latest deployment status for a device connected
+ * to Device Update for IoT Hub.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deviceId: String (Required)
* moduleId: String (Optional)
@@ -386,16 +409,17 @@ public PollerFlux beginImportDevices(BinaryData importTy
* ]
* }
* }
- * }
- *
+ * }
+ *
+ *
* @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}.
+ * @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)
@@ -404,12 +428,12 @@ public MonoResponse Body Schema - * - *
{@code
+ * Gets the device module properties and latest deployment status for a device
+ * module connected to Device Update for IoT Hub.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deviceId: String (Required)
* moduleId: String (Optional)
@@ -443,8 +467,9 @@ public Mono> getDeviceWithResponse(String deviceId, Request
* ]
* }
* }
- * }
- *
+ * }
+ *
+ *
* @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.
@@ -452,8 +477,9 @@ public MonoResponse Body Schema - * - *
{@code
+ * Gets the breakdown of how many devices are on their latest update, have new
+ * updates available, or are in progress receiving new updates.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* totalDeviceCount: int (Required)
* onLatestUpdateDeviceCount: int (Required)
* newUpdatesAvailableDeviceCount: int (Required)
* updatesInProgressDeviceCount: int (Required)
* }
- * }
- *
+ * }
+ *
+ *
* @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}.
+ * @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)
@@ -492,40 +520,37 @@ public MonoQuery Parameters - * + * Gets a list of all device groups. The $default group will always be returned + * first. + *
Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| orderby | String | No | Orders the set of groups returned. You can order by groupId, deviceCount, createdDate, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. |
| Name | Type | Required | Description |
| orderby | String | No | Orders the set of groups returned. You can order by groupId, + * deviceCount, + * createdDate, subgroupsWithNewUpdatesAvailableCount, + * subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * groupId: String (Required)
- * groupType: String(IoTHubTag/DefaultNoTag) (Required)
- * createdDateTime: String (Required)
- * deviceCount: Integer (Optional)
- * subgroupsWithNewUpdatesAvailableCount: Integer (Optional)
- * subgroupsWithUpdatesInProgressCount: Integer (Optional)
- * subgroupsWithOnLatestUpdateCount: Integer (Optional)
- * deployments (Optional): [
- * String (Optional)
- * ]
- * }
+ * groupId: String (Required)
+ * groupType: String(IoTHubTag/DefaultNoTag) (Required)
+ * createdDateTime: String (Required)
+ * deviceCount: Integer (Optional)
+ * subgroupsWithNewUpdatesAvailableCount: Integer (Optional)
+ * subgroupsWithUpdatesInProgressCount: Integer (Optional)
+ * subgroupsWithOnLatestUpdateCount: Integer (Optional)
+ * deployments (Optional): [
+ * String (Optional)
* ]
- * nextLink: String (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @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.
@@ -541,10 +566,10 @@ public PagedFluxResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* groupId: String (Required)
* groupType: String(IoTHubTag/DefaultNoTag) (Required)
@@ -557,8 +582,9 @@ public PagedFlux listGroups(RequestOptions requestOptions) {
* String (Optional)
* ]
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group 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.
@@ -574,12 +600,14 @@ public MonoResponse Body Schema - * - *
{@code
+ * Get device group update compliance information such as how many devices are on
+ * their latest update, how many need new updates, and how many are in progress on
+ * receiving a new update.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* totalDeviceCount: int (Required)
* onLatestUpdateDeviceCount: int (Required)
* newUpdatesAvailableDeviceCount: int (Required)
* updatesInProgressDeviceCount: int (Required)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group 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 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}.
+ * @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)
@@ -627,40 +657,37 @@ public MonoResponse Body Schema - * - *
{@code
+ * Get the best available updates for a device group and a count of how many
+ * devices need each update.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * groupId: String (Required)
- * deviceClassId: String (Required)
- * update (Required): {
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * }
- * deviceCount: int (Required)
+ * groupId: String (Required)
+ * deviceClassId: String (Required)
+ * update (Required): {
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
* }
- * ]
- * nextLink: String (Optional)
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
+ * deviceCount: int (Required)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group 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 updates for a device group and a count of how many devices need each update as
- * paginated response with {@link PagedFlux}.
+ * @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)
@@ -670,54 +697,49 @@ public PagedFluxQuery Parameters - * + *
Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| orderby | String | No | Orders the set of deployments returned. You can order by start date. |
| Name | Type | Required | Description |
| orderby | String | No | Orders the set of deployments returned. You can order by start + * date. |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deploymentId: String (Required)
- * startDateTime: OffsetDateTime (Required)
- * update (Required): {
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * }
- * groupId: String (Required)
- * deviceClassSubgroups (Optional): [
- * String (Optional)
- * ]
- * isCanceled: Boolean (Optional)
- * isRetried: Boolean (Optional)
- * rollbackPolicy (Optional): {
- * update (Required): (recursive schema, see update above)
- * failure (Required): {
- * devicesFailedPercentage: int (Required)
- * devicesFailedCount: int (Required)
- * }
- * }
- * isCloudInitiatedRollback: Boolean (Optional)
+ * deploymentId: String (Required)
+ * startDateTime: OffsetDateTime (Required)
+ * update (Required): {
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
* }
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
+ * groupId: String (Required)
+ * deviceClassSubgroups (Optional): [
+ * String (Optional)
* ]
- * nextLink: String (Optional)
+ * isCanceled: Boolean (Optional)
+ * isRetried: Boolean (Optional)
+ * rollbackPolicy (Optional): {
+ * update (Required): (recursive schema, see update above)
+ * failure (Required): {
+ * devicesFailedPercentage: int (Required)
+ * devicesFailedCount: int (Required)
+ * }
+ * }
+ * isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group 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.
@@ -734,10 +756,10 @@ public PagedFluxResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -764,9 +786,11 @@ public PagedFlux listDeploymentsForGroup(String groupId, RequestOpti
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group identifier.
* @param deploymentId Deployment identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -785,10 +809,10 @@ public MonoRequest Body Schema - * - *
{@code
+ * Request Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -815,12 +839,15 @@ public Mono> getDeploymentWithResponse(String groupId, Stri
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
* }
- * }
- *
- * Response Body Schema
- *
- *
{@code
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -847,9 +874,11 @@ public Mono> getDeploymentWithResponse(String groupId, Stri
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group identifier.
* @param deploymentId Deployment identifier.
* @param deployment The deployment properties.
@@ -870,7 +899,7 @@ public MonoResponse Body Schema - * - *
{@code
+ * Gets the status of a deployment including a breakdown of how many devices in
+ * the deployment are in progress, completed, or failed.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* groupId: String (Required)
* deploymentState: String(Active/ActiveWithSubgroupFailures/Failed/Inactive/Canceled) (Required)
@@ -926,8 +955,9 @@ public Mono> deleteDeploymentWithResponse(String groupId, String
* }
* ]
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deploymentId Deployment identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -935,8 +965,9 @@ public MonoQuery Parameters - * + * Get the device class subgroups for the group. A device class subgroup is the + * set of devices within the group that share the same device class. All devices + * within the same device class are compatible with the same updates. + *
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. (i.e. filter=compatProperties/propertyName1 eq 'value1' and compatProperties/propertyName2 eq 'value2') |
| 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. (i.e. filter=compatProperties/propertyName1 eq + * 'value1' and compatProperties/propertyName2 eq 'value2') |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deviceClassId: String (Required)
- * groupId: String (Required)
- * createdDateTime: String (Required)
- * deviceCount: Integer (Optional)
- * deploymentId: String (Optional)
- * }
- * ]
- * nextLink: String (Optional)
+ * deviceClassId: String (Required)
+ * groupId: String (Required)
+ * createdDateTime: String (Required)
+ * deviceCount: Integer (Optional)
+ * deploymentId: String (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group 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.
@@ -991,12 +1019,13 @@ public PagedFluxResponse Body Schema - * - *
{@code
+ * Gets device class subgroup details. A device class subgroup is the set of
+ * devices within the group that share the same device class. All devices within
+ * the same device class are compatible with the same updates.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deviceClassId: String (Required)
* groupId: String (Required)
@@ -1004,8 +1033,9 @@ public PagedFlux listDeviceClassSubgroupsForGroup(String groupId, Re
* deviceCount: Integer (Optional)
* deploymentId: String (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -1023,12 +1053,15 @@ public MonoResponse Body Schema - * - *
{@code
+ * Get device class subgroup update compliance information such as how many
+ * devices are on their latest update, how many need new updates, and how many are
+ * in progress on receiving a new update.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* totalDeviceCount: int (Required)
* onLatestUpdateDeviceCount: int (Required)
* newUpdatesAvailableDeviceCount: int (Required)
* updatesInProgressDeviceCount: int (Required)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -1067,9 +1102,9 @@ public MonoResponse Body Schema - * - *
{@code
+ * Get the best available update for a device class subgroup and a count of how
+ * many devices need this update.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* groupId: String (Required)
* deviceClassId: String (Required)
@@ -1099,8 +1135,9 @@ public Mono> getDeviceClassSubgroupUpdateComplianceWithResp
* }
* deviceCount: int (Required)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -1108,8 +1145,8 @@ public MonoQuery Parameters - * + *
Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| orderby | String | No | Orders the set of deployments returned. You can order by start date. |
| Name | Type | Required | Description |
| orderby | String | No | Orders the set of deployments returned. You can order by start + * date. |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deploymentId: String (Required)
- * startDateTime: OffsetDateTime (Required)
- * update (Required): {
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * }
- * groupId: String (Required)
- * deviceClassSubgroups (Optional): [
- * String (Optional)
- * ]
- * isCanceled: Boolean (Optional)
- * isRetried: Boolean (Optional)
- * rollbackPolicy (Optional): {
- * update (Required): (recursive schema, see update above)
- * failure (Required): {
- * devicesFailedPercentage: int (Required)
- * devicesFailedCount: int (Required)
- * }
- * }
- * isCloudInitiatedRollback: Boolean (Optional)
+ * deploymentId: String (Required)
+ * startDateTime: OffsetDateTime (Required)
+ * update (Required): {
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
* }
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
+ * groupId: String (Required)
+ * deviceClassSubgroups (Optional): [
+ * String (Optional)
* ]
- * nextLink: String (Optional)
+ * isCanceled: Boolean (Optional)
+ * isRetried: Boolean (Optional)
+ * rollbackPolicy (Optional): {
+ * update (Required): (recursive schema, see update above)
+ * failure (Required): {
+ * devicesFailedPercentage: int (Required)
+ * devicesFailedCount: int (Required)
+ * }
+ * }
+ * isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -1187,10 +1219,10 @@ public PagedFluxResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -1217,9 +1249,11 @@ public PagedFlux listDeploymentsForDeviceClassSubgroup(String groupI
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param deploymentId Deployment identifier.
@@ -1240,7 +1274,7 @@ public MonoResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -1291,9 +1325,11 @@ public Mono> deleteDeploymentForDeviceClassSubgroupWithResponse(S
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param deploymentId Deployment identifier.
@@ -1313,10 +1349,10 @@ public MonoResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -1343,9 +1379,11 @@ public Mono> stopDeploymentWithResponse(String groupId, Str
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param deploymentId Deployment identifier.
@@ -1365,12 +1403,12 @@ public MonoResponse Body Schema - * - *
{@code
+ * Gets the status of a deployment including a breakdown of how many devices in
+ * the deployment are in progress, completed, or failed.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* groupId: String (Required)
* deviceClassId: String (Required)
@@ -1396,8 +1434,9 @@ public Mono> retryDeploymentWithResponse(String groupId, St
* devicesCompletedSucceededCount: Integer (Optional)
* devicesCanceledCount: Integer (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param deploymentId Deployment identifier.
@@ -1406,8 +1445,9 @@ public MonoQuery Parameters - * + * Gets a list of devices in a deployment along with their state. Useful for + * getting a list of failed devices. + *
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. |
| 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
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deviceId: String (Required)
- * moduleId: String (Optional)
- * retryCount: int (Required)
- * movedOnToNewDeployment: boolean (Required)
- * deviceState: String(Succeeded/InProgress/Canceled/Failed) (Required)
- * }
- * ]
- * nextLink: String (Optional)
+ * deviceId: String (Required)
+ * moduleId: String (Optional)
+ * retryCount: int (Required)
+ * movedOnToNewDeployment: boolean (Required)
+ * deviceState: String(Succeeded/InProgress/Canceled/Failed) (Required)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param deploymentId Deployment identifier.
@@ -1467,20 +1503,19 @@ public PagedFluxHeader Parameters - * + *
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. |
| 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
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* operationId: String (Required)
* status: String(NotStarted/Running/Succeeded/Failed) (Required)
@@ -1504,8 +1539,9 @@ public PagedFlux listDeviceStatesForDeviceClassSubgroupDeployment(St
* createdDateTime: OffsetDateTime (Required)
* etag: String (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @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.
@@ -1522,52 +1558,51 @@ public MonoQuery Parameters - * + * Get a list of all device import operations. Completed operations are kept for 7 + * days before auto-deleted. + *
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. |
| 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
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * operationId: String (Required)
- * status: String(NotStarted/Running/Succeeded/Failed) (Required)
- * error (Optional): {
- * code: String (Required)
- * message: String (Required)
- * target: String (Optional)
- * details (Optional): [
- * (recursive schema, see above)
- * ]
- * innererror (Optional): {
- * code: String (Required)
- * message: String (Optional)
- * errorDetail: String (Optional)
- * innerError (Optional): (recursive schema, see innerError above)
- * }
- * occurredDateTime: OffsetDateTime (Optional)
- * }
- * traceId: String (Optional)
- * lastActionDateTime: OffsetDateTime (Required)
- * createdDateTime: OffsetDateTime (Required)
- * etag: String (Optional)
+ * operationId: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Required)
+ * message: String (Optional)
+ * errorDetail: String (Optional)
+ * innerError (Optional): (recursive schema, see innerError above)
* }
- * ]
- * nextLink: String (Optional)
+ * occurredDateTime: OffsetDateTime (Optional)
+ * }
+ * traceId: String (Optional)
+ * lastActionDateTime: OffsetDateTime (Required)
+ * createdDateTime: OffsetDateTime (Required)
+ * etag: String (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @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.
@@ -1583,10 +1618,10 @@ public PagedFluxRequest Body Schema - * - *
{@code
+ * Request Body Schema
+ *
+ *
+ * {@code
* {
* operationId: String (Optional)
* deviceList (Required): [
@@ -1600,11 +1635,13 @@ public PagedFlux listOperationStatuses(RequestOptions requestOptions
* lastActionDateTime: String (Optional)
* status: String(NotStarted/Running/Succeeded/Failed) (Optional)
* }
- * }
- *
- * Response Body Schema
- *
- *
{@code
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* operationId: String (Optional)
* deviceList (Required): [
@@ -1618,8 +1655,9 @@ public PagedFlux listOperationStatuses(RequestOptions requestOptions
* lastActionDateTime: String (Optional)
* status: String(NotStarted/Running/Succeeded/Failed) (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param logCollectionId Log collection identifier.
* @param logCollection The log collection properties.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -1638,10 +1676,10 @@ public MonoResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* operationId: String (Optional)
* deviceList (Required): [
@@ -1655,16 +1693,17 @@ public Mono> startLogCollectionWithResponse(String logColle
* lastActionDateTime: String (Optional)
* status: String(NotStarted/Running/Succeeded/Failed) (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param logCollectionId Log collection 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 along with {@link Response} on successful completion of {@link
- * Mono}.
+ * @return the device diagnostics log collection along with {@link Response} on successful completion of
+ * {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
@@ -1675,30 +1714,26 @@ public MonoResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
+ * operationId: String (Optional)
+ * deviceList (Required): [
* (Required){
- * operationId: String (Optional)
- * deviceList (Required): [
- * (Required){
- * deviceId: String (Required)
- * moduleId: String (Optional)
- * }
- * ]
- * description: String (Optional)
- * createdDateTime: String (Optional)
- * lastActionDateTime: String (Optional)
- * status: String(NotStarted/Running/Succeeded/Failed) (Optional)
+ * deviceId: String (Required)
+ * moduleId: String (Optional)
* }
* ]
- * nextLink: String (Optional)
+ * description: String (Optional)
+ * createdDateTime: String (Optional)
+ * lastActionDateTime: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Failed) (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @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.
@@ -1714,10 +1749,10 @@ public PagedFluxResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* operationId: String (Optional)
* createdDateTime: String (Optional)
@@ -1735,8 +1770,9 @@ public PagedFlux listLogCollections(RequestOptions requestOptions) {
* ]
* description: String (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param logCollectionId Log collection 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.
@@ -1754,31 +1790,27 @@ public MonoResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
+ * deviceId: String (Required)
+ * moduleId: String (Optional)
+ * state: String(healthy/unhealthy) (Required)
+ * digitalTwinModelId: String (Optional)
+ * healthChecks (Required): [
* (Required){
- * deviceId: String (Required)
- * moduleId: String (Optional)
- * state: String(healthy/unhealthy) (Required)
- * digitalTwinModelId: String (Optional)
- * healthChecks (Required): [
- * (Required){
- * name: String (Optional)
- * result: String(success/userError) (Optional)
- * }
- * ]
+ * name: String (Optional)
+ * result: String(success/userError) (Optional)
* }
* ]
- * nextLink: String (Optional)
* }
- * }
- *
- * @param filter Restricts the set of devices for which device health is returned. You can filter on status, device
- * id and module id.
+ * }
+ *
+ *
+ * @param filter Restricts the set of devices for which device health is returned. You can
+ * filter on status, device id and module id.
* @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.
@@ -1791,4 +1823,1388 @@ public MonoQuery Parameters - * + * Gets a list of all device classes (sets of devices compatible with the same + * updates based on the model Id and compat properties reported in the Device + * Update PnP interface in IoT Hub) for all devices connected to Device Update for + * IoT Hub. + *
Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| filter | String | No | Restricts the set of device classes returned. You can filter on friendly name. |
| Name | Type | Required | Description |
| filter | String | No | Restricts the set of device classes returned. You can filter on + * friendly name. |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deviceClassId: String (Required)
- * friendlyName: String (Optional)
- * deviceClassProperties (Required): {
- * contractModel (Optional): {
- * id: String (Required)
- * name: String (Required)
- * }
- * compatProperties (Required): {
- * String: String (Required)
- * }
- * }
- * bestCompatibleUpdate (Optional): {
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * }
+ * deviceClassId: String (Required)
+ * friendlyName: String (Optional)
+ * deviceClassProperties (Required): {
+ * contractModel (Optional): {
+ * id: String (Required)
+ * name: String (Required)
* }
- * ]
- * nextLink: String (Optional)
+ * compatProperties (Required): {
+ * String: String (Required)
+ * }
+ * }
+ * bestCompatibleUpdate (Optional): {
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
+ * }
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
* }
- * }
- *
+ * }
+ *
+ *
* @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 (sets of devices compatible with the same updates based on the model Id and
- * compat properties reported in the Device Update PnP interface in IoT Hub) for all devices connected to Device
- * Update for IoT Hub as paginated response with {@link PagedIterable}.
+ * @return a list of all device classes (sets of devices compatible with the same
+ * updates based on the model Id and compat properties reported in the Device
+ * Update PnP interface in IoT Hub) for all devices connected to Device Update for
+ * IoT Hub as paginated response with {@link PagedIterable}.
*/
@Generated
@ServiceMethod(returns = ReturnType.COLLECTION)
@@ -99,10 +116,10 @@ public PagedIterableResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deviceClassId: String (Required)
* friendlyName: String (Optional)
@@ -125,8 +142,9 @@ public PagedIterable listDeviceClasses(RequestOptions requestOptions
* friendlyName: String (Optional)
* }
* }
- * }
- *
+ * }
+ *
+ *
* @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.
@@ -143,18 +161,20 @@ public ResponseRequest Body Schema - * - *
{@code
+ * Request Body Schema
+ *
+ *
+ * {@code
* {
- * friendlyName: String (Required)
+ * friendlyName: String (Optional, Required on create)
* }
- * }
- *
- * Response Body Schema
- *
- *
{@code
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deviceClassId: String (Required)
* friendlyName: String (Optional)
@@ -177,10 +197,12 @@ public Response getDeviceClassWithResponse(String deviceClassId, Req
* friendlyName: String (Optional)
* }
* }
- * }
- *
+ * }
+ *
+ *
* @param deviceClassId Device class identifier.
- * @param deviceClassPatch The device class json merge patch body. Currently only supports patching friendlyName.
+ * @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.
@@ -196,12 +218,14 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * }
- * ]
- * nextLink: String (Optional)
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
+ * }
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @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.
@@ -255,67 +275,63 @@ public PagedIterableQuery Parameters - * + *
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. Use DeploymentStatus eq null to query for devices with no deployment status (that have never been deployed to). |
| Name | Type | Required | Description |
| filter | String | No | Restricts the set of devices returned. You can filter on + * GroupId, + * DeviceClassId, or GroupId and DeploymentStatus. Use DeploymentStatus eq null to + * query for devices with no deployment status (that have never been deployed to). |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deviceId: String (Required)
- * moduleId: String (Optional)
- * deviceClassId: String (Required)
- * groupId: String (Optional)
- * lastAttemptedUpdate (Optional): {
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
+ * deviceId: String (Required)
+ * moduleId: String (Optional)
+ * deviceClassId: String (Required)
+ * groupId: String (Optional)
+ * lastAttemptedUpdate (Optional): {
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
+ * }
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
+ * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) (Optional)
+ * installedUpdate (Optional): (recursive schema, see installedUpdate above)
+ * onLatestUpdate: boolean (Required)
+ * lastDeploymentId: String (Optional)
+ * lastInstallResult (Optional): {
+ * resultCode: int (Required)
+ * extendedResultCode: int (Required)
+ * resultDetails: String (Optional)
+ * stepResults (Optional): [
+ * (Optional){
+ * update (Optional): (recursive schema, see update above)
* description: String (Optional)
- * friendlyName: String (Optional)
- * }
- * deploymentStatus: String(Succeeded/InProgress/Canceled/Failed) (Optional)
- * installedUpdate (Optional): (recursive schema, see installedUpdate above)
- * onLatestUpdate: boolean (Required)
- * lastDeploymentId: String (Optional)
- * lastInstallResult (Optional): {
* resultCode: int (Required)
* extendedResultCode: int (Required)
* resultDetails: String (Optional)
- * stepResults (Optional): [
- * (Optional){
- * update (Optional): (recursive schema, see update above)
- * description: String (Optional)
- * resultCode: int (Required)
- * extendedResultCode: int (Required)
- * resultDetails: String (Optional)
- * }
- * ]
* }
- * }
- * ]
- * nextLink: String (Optional)
+ * ]
+ * }
+ * }
* }
- * }
- *
+ *
+ *
* @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}.
+ * @return a list of devices connected to Device Update for IoT Hub as paginated response with
+ * {@link PagedIterable}.
*/
@Generated
@ServiceMethod(returns = ReturnType.COLLECTION)
@@ -324,15 +340,16 @@ public PagedIterableRequest Body Schema - * - *
{@code
+ * Import existing devices from IoT Hub. This is a long-running-operation; use
+ * Operation-Location response header value to check for operation status.
+ * 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.
@@ -348,11 +365,12 @@ public SyncPollerResponse Body Schema - * - *
{@code
+ * Gets the device properties and latest deployment status for a device connected
+ * to Device Update for IoT Hub.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deviceId: String (Required)
* moduleId: String (Optional)
@@ -386,16 +404,17 @@ public SyncPoller beginImportDevices(BinaryData importTy
* ]
* }
* }
- * }
- *
+ * }
+ *
+ *
* @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}.
+ * @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)
@@ -404,12 +423,12 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Gets the device module properties and latest deployment status for a device
+ * module connected to Device Update for IoT Hub.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deviceId: String (Required)
* moduleId: String (Optional)
@@ -443,8 +462,9 @@ public Response getDeviceWithResponse(String deviceId, RequestOption
* ]
* }
* }
- * }
- *
+ * }
+ *
+ *
* @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.
@@ -452,8 +472,8 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Gets the breakdown of how many devices are on their latest update, have new
+ * updates available, or are in progress receiving new updates.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* totalDeviceCount: int (Required)
* onLatestUpdateDeviceCount: int (Required)
* newUpdatesAvailableDeviceCount: int (Required)
* updatesInProgressDeviceCount: int (Required)
* }
- * }
- *
+ * }
+ *
+ *
* @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}.
+ * @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)
@@ -492,40 +513,37 @@ public ResponseQuery Parameters - * + * Gets a list of all device groups. The $default group will always be returned + * first. + *
Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| orderby | String | No | Orders the set of groups returned. You can order by groupId, deviceCount, createdDate, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. |
| Name | Type | Required | Description |
| orderby | String | No | Orders the set of groups returned. You can order by groupId, + * deviceCount, + * createdDate, subgroupsWithNewUpdatesAvailableCount, + * subgroupsWithUpdatesInProgressCount, or subgroupsOnLatestUpdateCount. |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * groupId: String (Required)
- * groupType: String(IoTHubTag/DefaultNoTag) (Required)
- * createdDateTime: String (Required)
- * deviceCount: Integer (Optional)
- * subgroupsWithNewUpdatesAvailableCount: Integer (Optional)
- * subgroupsWithUpdatesInProgressCount: Integer (Optional)
- * subgroupsWithOnLatestUpdateCount: Integer (Optional)
- * deployments (Optional): [
- * String (Optional)
- * ]
- * }
+ * groupId: String (Required)
+ * groupType: String(IoTHubTag/DefaultNoTag) (Required)
+ * createdDateTime: String (Required)
+ * deviceCount: Integer (Optional)
+ * subgroupsWithNewUpdatesAvailableCount: Integer (Optional)
+ * subgroupsWithUpdatesInProgressCount: Integer (Optional)
+ * subgroupsWithOnLatestUpdateCount: Integer (Optional)
+ * deployments (Optional): [
+ * String (Optional)
* ]
- * nextLink: String (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @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.
@@ -541,10 +559,10 @@ public PagedIterableResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* groupId: String (Required)
* groupType: String(IoTHubTag/DefaultNoTag) (Required)
@@ -557,8 +575,9 @@ public PagedIterable listGroups(RequestOptions requestOptions) {
* String (Optional)
* ]
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group 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.
@@ -574,12 +593,14 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Get device group update compliance information such as how many devices are on
+ * their latest update, how many need new updates, and how many are in progress on
+ * receiving a new update.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* totalDeviceCount: int (Required)
* onLatestUpdateDeviceCount: int (Required)
* newUpdatesAvailableDeviceCount: int (Required)
* updatesInProgressDeviceCount: int (Required)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group 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 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}.
+ * @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)
@@ -625,40 +649,37 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Get the best available updates for a device group and a count of how many
+ * devices need each update.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * groupId: String (Required)
- * deviceClassId: String (Required)
- * update (Required): {
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * }
- * deviceCount: int (Required)
+ * groupId: String (Required)
+ * deviceClassId: String (Required)
+ * update (Required): {
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
* }
- * ]
- * nextLink: String (Optional)
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
+ * deviceCount: int (Required)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group 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 updates for a device group and a count of how many devices need each update as
- * paginated response with {@link PagedIterable}.
+ * @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)
@@ -668,54 +689,49 @@ public PagedIterableQuery Parameters - * + *
Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| orderby | String | No | Orders the set of deployments returned. You can order by start date. |
| Name | Type | Required | Description |
| orderby | String | No | Orders the set of deployments returned. You can order by start + * date. |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deploymentId: String (Required)
- * startDateTime: OffsetDateTime (Required)
- * update (Required): {
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * }
- * groupId: String (Required)
- * deviceClassSubgroups (Optional): [
- * String (Optional)
- * ]
- * isCanceled: Boolean (Optional)
- * isRetried: Boolean (Optional)
- * rollbackPolicy (Optional): {
- * update (Required): (recursive schema, see update above)
- * failure (Required): {
- * devicesFailedPercentage: int (Required)
- * devicesFailedCount: int (Required)
- * }
- * }
- * isCloudInitiatedRollback: Boolean (Optional)
+ * deploymentId: String (Required)
+ * startDateTime: OffsetDateTime (Required)
+ * update (Required): {
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
* }
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
+ * groupId: String (Required)
+ * deviceClassSubgroups (Optional): [
+ * String (Optional)
* ]
- * nextLink: String (Optional)
+ * isCanceled: Boolean (Optional)
+ * isRetried: Boolean (Optional)
+ * rollbackPolicy (Optional): {
+ * update (Required): (recursive schema, see update above)
+ * failure (Required): {
+ * devicesFailedPercentage: int (Required)
+ * devicesFailedCount: int (Required)
+ * }
+ * }
+ * isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group 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.
@@ -732,10 +748,10 @@ public PagedIterableResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -762,9 +778,11 @@ public PagedIterable listDeploymentsForGroup(String groupId, Request
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group identifier.
* @param deploymentId Deployment identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -783,10 +801,10 @@ public ResponseRequest Body Schema - * - *
{@code
+ * Request Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -813,12 +831,15 @@ public Response getDeploymentWithResponse(String groupId, String dep
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
* }
- * }
- *
- * Response Body Schema
- *
- *
{@code
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -845,9 +866,11 @@ public Response getDeploymentWithResponse(String groupId, String dep
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group identifier.
* @param deploymentId Deployment identifier.
* @param deployment The deployment properties.
@@ -868,7 +891,7 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Gets the status of a deployment including a breakdown of how many devices in
+ * the deployment are in progress, completed, or failed.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* groupId: String (Required)
* deploymentState: String(Active/ActiveWithSubgroupFailures/Failed/Inactive/Canceled) (Required)
@@ -924,8 +947,9 @@ public Response deleteDeploymentWithResponse(String groupId, String deploy
* }
* ]
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deploymentId Deployment identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -933,8 +957,8 @@ public ResponseQuery Parameters - * + * Get the device class subgroups for the group. A device class subgroup is the + * set of devices within the group that share the same device class. All devices + * within the same device class are compatible with the same updates. + *
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. (i.e. filter=compatProperties/propertyName1 eq 'value1' and compatProperties/propertyName2 eq 'value2') |
| 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. (i.e. filter=compatProperties/propertyName1 eq + * 'value1' and compatProperties/propertyName2 eq 'value2') |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deviceClassId: String (Required)
- * groupId: String (Required)
- * createdDateTime: String (Required)
- * deviceCount: Integer (Optional)
- * deploymentId: String (Optional)
- * }
- * ]
- * nextLink: String (Optional)
+ * deviceClassId: String (Required)
+ * groupId: String (Required)
+ * createdDateTime: String (Required)
+ * deviceCount: Integer (Optional)
+ * deploymentId: String (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group 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.
@@ -989,12 +1010,13 @@ public PagedIterableResponse Body Schema - * - *
{@code
+ * Gets device class subgroup details. A device class subgroup is the set of
+ * devices within the group that share the same device class. All devices within
+ * the same device class are compatible with the same updates.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deviceClassId: String (Required)
* groupId: String (Required)
@@ -1002,8 +1024,9 @@ public PagedIterable listDeviceClassSubgroupsForGroup(String groupId
* deviceCount: Integer (Optional)
* deploymentId: String (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -1021,12 +1044,15 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Get device class subgroup update compliance information such as how many
+ * devices are on their latest update, how many need new updates, and how many are
+ * in progress on receiving a new update.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* totalDeviceCount: int (Required)
* onLatestUpdateDeviceCount: int (Required)
* newUpdatesAvailableDeviceCount: int (Required)
* updatesInProgressDeviceCount: int (Required)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -1065,9 +1093,9 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Get the best available update for a device class subgroup and a count of how
+ * many devices need this update.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* groupId: String (Required)
* deviceClassId: String (Required)
@@ -1097,8 +1126,9 @@ public Response getDeviceClassSubgroupUpdateComplianceWithResponse(S
* }
* deviceCount: int (Required)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -1106,8 +1136,8 @@ public ResponseQuery Parameters - * + *
Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| orderby | String | No | Orders the set of deployments returned. You can order by start date. |
| Name | Type | Required | Description |
| orderby | String | No | Orders the set of deployments returned. You can order by start + * date. |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deploymentId: String (Required)
- * startDateTime: OffsetDateTime (Required)
- * update (Required): {
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * }
- * groupId: String (Required)
- * deviceClassSubgroups (Optional): [
- * String (Optional)
- * ]
- * isCanceled: Boolean (Optional)
- * isRetried: Boolean (Optional)
- * rollbackPolicy (Optional): {
- * update (Required): (recursive schema, see update above)
- * failure (Required): {
- * devicesFailedPercentage: int (Required)
- * devicesFailedCount: int (Required)
- * }
- * }
- * isCloudInitiatedRollback: Boolean (Optional)
+ * deploymentId: String (Required)
+ * startDateTime: OffsetDateTime (Required)
+ * update (Required): {
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
* }
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
+ * groupId: String (Required)
+ * deviceClassSubgroups (Optional): [
+ * String (Optional)
* ]
- * nextLink: String (Optional)
+ * isCanceled: Boolean (Optional)
+ * isRetried: Boolean (Optional)
+ * rollbackPolicy (Optional): {
+ * update (Required): (recursive schema, see update above)
+ * failure (Required): {
+ * devicesFailedPercentage: int (Required)
+ * devicesFailedCount: int (Required)
+ * }
+ * }
+ * isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -1185,10 +1210,10 @@ public PagedIterableResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -1215,9 +1240,11 @@ public PagedIterable listDeploymentsForDeviceClassSubgroup(String gr
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param deploymentId Deployment identifier.
@@ -1238,7 +1265,7 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -1289,9 +1316,11 @@ public Response deleteDeploymentForDeviceClassSubgroupWithResponse(String
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param deploymentId Deployment identifier.
@@ -1311,10 +1340,10 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* deploymentId: String (Required)
* startDateTime: OffsetDateTime (Required)
@@ -1341,9 +1370,11 @@ public Response stopDeploymentWithResponse(String groupId, String de
* }
* }
* isCloudInitiatedRollback: Boolean (Optional)
+ * downloadSecurity: String(https/http) (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param deploymentId Deployment identifier.
@@ -1362,12 +1393,12 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Gets the status of a deployment including a breakdown of how many devices in
+ * the deployment are in progress, completed, or failed.
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* groupId: String (Required)
* deviceClassId: String (Required)
@@ -1393,8 +1424,9 @@ public Response retryDeploymentWithResponse(String groupId, String d
* devicesCompletedSucceededCount: Integer (Optional)
* devicesCanceledCount: Integer (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param deploymentId Deployment identifier.
@@ -1403,8 +1435,8 @@ public ResponseQuery Parameters - * + * Gets a list of devices in a deployment along with their state. Useful for + * getting a list of failed devices. + *
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. |
| 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
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * deviceId: String (Required)
- * moduleId: String (Optional)
- * retryCount: int (Required)
- * movedOnToNewDeployment: boolean (Required)
- * deviceState: String(Succeeded/InProgress/Canceled/Failed) (Required)
- * }
- * ]
- * nextLink: String (Optional)
+ * deviceId: String (Required)
+ * moduleId: String (Optional)
+ * retryCount: int (Required)
+ * movedOnToNewDeployment: boolean (Required)
+ * deviceState: String(Succeeded/InProgress/Canceled/Failed) (Required)
+ * }
* }
- * }
- *
+ *
+ *
* @param groupId Group identifier.
* @param deviceClassId Device class identifier.
* @param deploymentId Deployment identifier.
@@ -1452,8 +1480,8 @@ public ResponseHeader Parameters - * + *
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. |
| 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
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* operationId: String (Required)
* status: String(NotStarted/Running/Succeeded/Failed) (Required)
@@ -1502,8 +1529,9 @@ public PagedIterable listDeviceStatesForDeviceClassSubgroupDeploymen
* createdDateTime: OffsetDateTime (Required)
* etag: String (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @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.
@@ -1519,52 +1547,51 @@ public ResponseQuery Parameters - * + * Get a list of all device import operations. Completed operations are kept for 7 + * days before auto-deleted. + *
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. |
| 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
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * operationId: String (Required)
- * status: String(NotStarted/Running/Succeeded/Failed) (Required)
- * error (Optional): {
- * code: String (Required)
- * message: String (Required)
- * target: String (Optional)
- * details (Optional): [
- * (recursive schema, see above)
- * ]
- * innererror (Optional): {
- * code: String (Required)
- * message: String (Optional)
- * errorDetail: String (Optional)
- * innerError (Optional): (recursive schema, see innerError above)
- * }
- * occurredDateTime: OffsetDateTime (Optional)
- * }
- * traceId: String (Optional)
- * lastActionDateTime: OffsetDateTime (Required)
- * createdDateTime: OffsetDateTime (Required)
- * etag: String (Optional)
+ * operationId: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed) (Required)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Required)
+ * message: String (Optional)
+ * errorDetail: String (Optional)
+ * innerError (Optional): (recursive schema, see innerError above)
* }
- * ]
- * nextLink: String (Optional)
+ * occurredDateTime: OffsetDateTime (Optional)
+ * }
+ * traceId: String (Optional)
+ * lastActionDateTime: OffsetDateTime (Required)
+ * createdDateTime: OffsetDateTime (Required)
+ * etag: String (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @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.
@@ -1580,10 +1607,10 @@ public PagedIterableRequest Body Schema - * - *
{@code
+ * Request Body Schema
+ *
+ *
+ * {@code
* {
* operationId: String (Optional)
* deviceList (Required): [
@@ -1597,11 +1624,13 @@ public PagedIterable listOperationStatuses(RequestOptions requestOpt
* lastActionDateTime: String (Optional)
* status: String(NotStarted/Running/Succeeded/Failed) (Optional)
* }
- * }
- *
- * Response Body Schema
- *
- *
{@code
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* operationId: String (Optional)
* deviceList (Required): [
@@ -1615,8 +1644,9 @@ public PagedIterable listOperationStatuses(RequestOptions requestOpt
* lastActionDateTime: String (Optional)
* status: String(NotStarted/Running/Succeeded/Failed) (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param logCollectionId Log collection identifier.
* @param logCollection The log collection properties.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -1635,10 +1665,10 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* operationId: String (Optional)
* deviceList (Required): [
@@ -1652,8 +1682,9 @@ public Response startLogCollectionWithResponse(String logCollectionI
* lastActionDateTime: String (Optional)
* status: String(NotStarted/Running/Succeeded/Failed) (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param logCollectionId Log collection 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.
@@ -1670,30 +1701,26 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
+ * operationId: String (Optional)
+ * deviceList (Required): [
* (Required){
- * operationId: String (Optional)
- * deviceList (Required): [
- * (Required){
- * deviceId: String (Required)
- * moduleId: String (Optional)
- * }
- * ]
- * description: String (Optional)
- * createdDateTime: String (Optional)
- * lastActionDateTime: String (Optional)
- * status: String(NotStarted/Running/Succeeded/Failed) (Optional)
+ * deviceId: String (Required)
+ * moduleId: String (Optional)
* }
* ]
- * nextLink: String (Optional)
+ * description: String (Optional)
+ * createdDateTime: String (Optional)
+ * lastActionDateTime: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Failed) (Optional)
+ * }
* }
- * }
- *
+ *
+ *
* @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.
@@ -1709,10 +1736,10 @@ public PagedIterableResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* operationId: String (Optional)
* createdDateTime: String (Optional)
@@ -1730,8 +1757,9 @@ public PagedIterable listLogCollections(RequestOptions requestOption
* ]
* description: String (Optional)
* }
- * }
- *
+ * }
+ *
+ *
* @param logCollectionId Log collection 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.
@@ -1749,31 +1777,27 @@ public ResponseResponse Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
+ * deviceId: String (Required)
+ * moduleId: String (Optional)
+ * state: String(healthy/unhealthy) (Required)
+ * digitalTwinModelId: String (Optional)
+ * healthChecks (Required): [
* (Required){
- * deviceId: String (Required)
- * moduleId: String (Optional)
- * state: String(healthy/unhealthy) (Required)
- * digitalTwinModelId: String (Optional)
- * healthChecks (Required): [
- * (Required){
- * name: String (Optional)
- * result: String(success/userError) (Optional)
- * }
- * ]
+ * name: String (Optional)
+ * result: String(success/userError) (Optional)
* }
* ]
- * nextLink: String (Optional)
* }
- * }
- *
- * @param filter Restricts the set of devices for which device health is returned. You can filter on status, device
- * id and module id.
+ * }
+ *
+ *
+ * @param filter Restricts the set of devices for which device health is returned. You can
+ * filter on status, device id and module id.
* @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.
@@ -1786,4 +1810,1140 @@ public ResponseQuery Parameters - * + *
Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| search | String | No | Request updates matching a free-text search expression. |
| filter | String | No | Optional to filter updates by isDeployable property. |
| Name | Type | Required | Description |
| search | String | No | Request updates matching a free-text search + * expression. |
| filter | String | No | Optional to filter updates by isDeployable property. |
Response Body Schema - * - *
{@code
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
+ * }
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * isDeployable: Boolean (Optional)
+ * updateType: String (Optional)
+ * installedCriteria: String (Optional)
+ * compatibility (Required): [
* (Required){
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
+ * (Optional): {
+ * String: String (Required)
* }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * isDeployable: Boolean (Optional)
- * updateType: String (Optional)
- * installedCriteria: String (Optional)
- * compatibility (Required): [
- * (Required){
- * String: String (Required)
+ * }
+ * ]
+ * instructions (Optional): {
+ * steps (Required): [
+ * (Required){
+ * type: String(inline/reference) (Optional)
+ * description: String (Optional)
+ * handler: String (Optional)
+ * handlerProperties (Optional): {
+ * String: BinaryData (Required)
* }
- * ]
- * instructions (Optional): {
- * steps (Required): [
- * (Required){
- * type: String(Inline/Reference) (Optional)
- * description: String (Optional)
- * handler: String (Optional)
- * handlerProperties: Object (Optional)
- * files (Optional): [
- * String (Optional)
- * ]
- * updateId (Optional): (recursive schema, see updateId above)
- * }
+ * files (Optional): [
+ * String (Optional)
* ]
+ * updateId (Optional): (recursive schema, see updateId above)
* }
- * referencedBy (Optional): [
- * (recursive schema, see above)
- * ]
- * scanResult: String (Optional)
- * manifestVersion: String (Required)
- * importedDateTime: OffsetDateTime (Required)
- * createdDateTime: OffsetDateTime (Required)
- * etag: String (Optional)
- * }
+ * ]
+ * }
+ * referencedBy (Optional): [
+ * (recursive schema, see above)
* ]
- * nextLink: String (Optional)
+ * scanResult: String (Optional)
+ * manifestVersion: String (Required)
+ * importedDateTime: OffsetDateTime (Required)
+ * createdDateTime: OffsetDateTime (Required)
+ * etag: String (Optional)
+ * }
* }
- * }
+ *
*
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
@@ -105,7 +116,7 @@ public final class DeviceUpdateAsyncClient {
* @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}.
+ * {@link PagedFlux}.
*/
@Generated
@ServiceMethod(returns = ReturnType.COLLECTION)
@@ -114,12 +125,12 @@ public PagedFluxRequest Body Schema - * - *
{@code
+ * Import new update version. This is a long-running-operation; use
+ * Operation-Location response header value to check for operation status.
+ * Request Body Schema
+ *
+ *
+ * {@code
* [
* (Required){
* importManifest (Required): {
@@ -138,11 +149,13 @@ public PagedFlux listUpdates(RequestOptions requestOptions) {
* ]
* }
* ]
- * }
- *
- * Response Body Schema
- *
- *
{@code
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* updateId (Required): {
* provider: String (Required)
@@ -156,16 +169,20 @@ public PagedFlux listUpdates(RequestOptions requestOptions) {
* installedCriteria: String (Optional)
* compatibility (Required): [
* (Required){
- * String: String (Required)
+ * (Optional): {
+ * String: String (Required)
+ * }
* }
* ]
* instructions (Optional): {
* steps (Required): [
* (Required){
- * type: String(Inline/Reference) (Optional)
+ * type: String(inline/reference) (Optional)
* description: String (Optional)
* handler: String (Optional)
- * handlerProperties: Object (Optional)
+ * handlerProperties (Optional): {
+ * String: BinaryData (Required)
+ * }
* files (Optional): [
* String (Optional)
* ]
@@ -182,10 +199,12 @@ public PagedFlux listUpdates(RequestOptions requestOptions) {
* createdDateTime: OffsetDateTime (Required)
* etag: String (Optional)
* }
- * }
+ * }
+ *
*
* @param updateToImport The update to be imported (see schema
- * https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json for details).
+ * https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json for
+ * details).
* @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.
@@ -202,20 +221,19 @@ public PollerFluxHeader Parameters - * + *
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. |
| 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
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* updateId (Required): {
* provider: String (Required)
@@ -229,16 +247,20 @@ public PollerFlux beginImportUpdate(BinaryData updateToI
* installedCriteria: String (Optional)
* compatibility (Required): [
* (Required){
- * String: String (Required)
+ * (Optional): {
+ * String: String (Required)
+ * }
* }
* ]
* instructions (Optional): {
* steps (Required): [
* (Required){
- * type: String(Inline/Reference) (Optional)
+ * type: String(inline/reference) (Optional)
* description: String (Optional)
* handler: String (Optional)
- * handlerProperties: Object (Optional)
+ * handlerProperties (Optional): {
+ * String: BinaryData (Required)
+ * }
* files (Optional): [
* String (Optional)
* ]
@@ -255,7 +277,8 @@ public PollerFlux beginImportUpdate(BinaryData updateToI
* createdDateTime: OffsetDateTime (Required)
* etag: String (Optional)
* }
- * }
+ * }
+ *
*
* @param provider Update provider.
* @param name Update name.
@@ -275,8 +298,8 @@ public MonoResponse Body Schema - * - *
{@code
- * {
- * value (Required): [
- * String (Required)
- * ]
- * nextLink: String (Optional)
+ * Get a list of all update providers that have been imported to Device Update for
+ * IoT Hub.
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * 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}.
+ * @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)
@@ -325,17 +345,13 @@ public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * value (Required): [
- * String (Required)
- * ]
- * nextLink: String (Optional)
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * String
* }
- * }
+ *
*
* @param provider Update provider.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -343,8 +359,8 @@ public PagedFluxQuery Parameters - * + *
Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| filter | String | No | Optional to filter updates by isDeployable property. |
| Name | Type | Required | Description |
| filter | String | No | Optional to filter updates by isDeployable property. |
Response Body Schema - * - *
{@code
- * {
- * value (Required): [
- * String (Required)
- * ]
- * nextLink: String (Optional)
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * String
* }
- * }
+ *
*
* @param provider Update provider.
* @param name Update name.
@@ -384,7 +393,7 @@ public PagedFluxResponse Body Schema - * - *
{@code
- * {
- * value (Required): [
- * String (Required)
- * ]
- * nextLink: String (Optional)
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * String
* }
- * }
+ *
*
* @param provider Update provider.
* @param name Update name.
@@ -414,8 +419,8 @@ public PagedFluxHeader Parameters - * + *
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. |
| 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
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* fileName: String (Required)
* sizeInBytes: long (Required)
@@ -450,7 +454,7 @@ public PagedFlux listFiles(String provider, String name, String vers
* scanResult: String (Optional)
* scanDetails: String (Optional)
* properties (Optional): {
- * String: String (Optional)
+ * String: String (Required)
* }
* fileId: String (Required)
* relatedFiles (Optional): [
@@ -464,7 +468,7 @@ public PagedFlux listFiles(String provider, String name, String vers
* scanResult: String (Optional)
* scanDetails: String (Optional)
* properties (Optional): {
- * String: String (Optional)
+ * String: String (Required)
* }
* }
* ]
@@ -473,7 +477,8 @@ public PagedFlux listFiles(String provider, String name, String vers
* }
* etag: String (Optional)
* }
- * }
+ * }
+ *
*
* @param provider Update provider.
* @param name Update name.
@@ -484,8 +489,8 @@ public PagedFluxQuery Parameters - * + * Get a list of all import update operations. Completed operations are kept for 7 + * days before auto-deleted. Delete operations are not returned by this API + * version. + *
Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| filter | String | No | Optional to filter operations by status property. 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. |
| Name | Type | Required | Description |
| filter | String | No | Optional to filter operations by status property. 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
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
- * value (Required): [
- * (Required){
- * operationId: String (Required)
- * status: String(NotStarted/Running/Succeeded/Failed) (Required)
- * update (Optional): {
- * updateId (Required): {
- * provider: String (Required)
- * name: String (Required)
- * version: String (Required)
- * }
- * description: String (Optional)
- * friendlyName: String (Optional)
- * }
- * resourceLocation: String (Optional)
- * error (Optional): {
- * code: String (Required)
- * message: String (Required)
- * target: String (Optional)
- * details (Optional): [
- * (recursive schema, see above)
- * ]
- * innererror (Optional): {
- * code: String (Required)
- * message: String (Optional)
- * errorDetail: String (Optional)
- * innerError (Optional): (recursive schema, see innerError above)
- * }
- * occurredDateTime: OffsetDateTime (Optional)
- * }
- * traceId: String (Optional)
- * lastActionDateTime: OffsetDateTime (Required)
- * createdDateTime: OffsetDateTime (Required)
- * etag: String (Optional)
+ * operationId: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed) (Required)
+ * update (Optional): {
+ * updateId (Required): {
+ * provider: String (Required)
+ * name: String (Required)
+ * version: String (Required)
* }
- * ]
- * nextLink: String (Optional)
+ * description: String (Optional)
+ * friendlyName: String (Optional)
+ * }
+ * resourceLocation: String (Optional)
+ * error (Optional): {
+ * code: String (Required)
+ * message: String (Required)
+ * target: String (Optional)
+ * details (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * innererror (Optional): {
+ * code: String (Required)
+ * message: String (Optional)
+ * errorDetail: String (Optional)
+ * innerError (Optional): (recursive schema, see innerError above)
+ * }
+ * occurredDateTime: OffsetDateTime (Optional)
+ * }
+ * traceId: String (Optional)
+ * lastActionDateTime: OffsetDateTime (Required)
+ * createdDateTime: OffsetDateTime (Required)
+ * etag: String (Optional)
* }
- * }
+ * }
+ *
*
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
@@ -567,20 +571,19 @@ public PagedFluxHeader Parameters - * + *
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. |
| 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
+ * Response Body Schema
+ *
+ *
+ * {@code
* {
* operationId: String (Required)
* status: String(NotStarted/Running/Succeeded/Failed) (Required)
@@ -614,7 +617,8 @@ public PagedFlux listOperationStatuses(RequestOptions requestOptions
* createdDateTime: OffsetDateTime (Required)
* etag: String (Optional)
* }
- * }
+ * }
+ *
*
* @param operationId Operation identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
@@ -630,4 +634,520 @@ public Mono