DeviceUpdateClient Class

public SyncPoller beginDeleteUpdate(String provider, String name, String version, RequestOptions requestOptions)

Delete a specific update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.

Parameters:

Returns:

public SyncPoller beginImportUpdate(BinaryData updateToImport, RequestOptions requestOptions)

Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.

Request Body Schema

[
      (Required){
         importManifest (Required): {
             url: String (Required)
             sizeInBytes: long (Required)
             hashes (Required): {
                 String: String (Required)
             }
         }
         friendlyName: String (Optional)
         files (Optional): [
              (Optional){
                 filename: String (Required)
                 url: String (Required)
             }
         ]
     }
 ]

Response Body Schema

{
     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){
             String: String (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)
             }
         ]
     }
     referencedBy (Optional): [
         (recursive schema, see above)
     ]
     scanResult: String (Optional)
     manifestVersion: String (Required)
     importedDateTime: OffsetDateTime (Required)
     createdDateTime: OffsetDateTime (Required)
     etag: String (Optional)
 }

Parameters:

Returns:

public Response getFileWithResponse(String provider, String name, String version, String fileId, RequestOptions requestOptions)

Get a specific update file from the version.

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. |

You can add these to a request with RequestOptions#addHeader

Response Body Schema

{
     fileName: String (Required)
     sizeInBytes: long (Required)
     hashes (Required): {
         String: String (Required)
     }
     mimeType: String (Optional)
     scanResult: String (Optional)
     scanDetails: String (Optional)
     properties (Optional): {
         String: String (Optional)
     }
     fileId: String (Required)
     relatedFiles (Optional): [
          (Optional){
             fileName: String (Required)
             sizeInBytes: long (Required)
             hashes (Required): {
                 String: String (Required)
             }
             mimeType: String (Optional)
             scanResult: String (Optional)
             scanDetails: String (Optional)
             properties (Optional): {
                 String: String (Optional)
             }
         }
     ]
     downloadHandler (Optional): {
         id: String (Required)
     }
     etag: String (Optional)
 }

Parameters:

Returns:

public Response getOperationStatusWithResponse(String operationId, RequestOptions requestOptions)

Retrieve operation status.

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. |

You can add these to a request with RequestOptions#addHeader

Response Body Schema

{
     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)
 }

Parameters:

Returns:

public Response getUpdateWithResponse(String provider, String name, String version, RequestOptions requestOptions)

Get a specific update version.

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. |

You can add these to a request with RequestOptions#addHeader

Response Body Schema

{
     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){
             String: String (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)
             }
         ]
     }
     referencedBy (Optional): [
         (recursive schema, see above)
     ]
     scanResult: String (Optional)
     manifestVersion: String (Required)
     importedDateTime: OffsetDateTime (Required)
     createdDateTime: OffsetDateTime (Required)
     etag: String (Optional)
 }

Parameters:

Returns:

public PagedIterable listFiles(String provider, String name, String version, RequestOptions requestOptions)

Get a list of all update file identifiers for the specified version.

Response Body Schema

{
     value (Required): [
         String (Required)
     ]
     nextLink: String (Optional)
 }

Parameters:

Returns:

public PagedIterable listNames(String provider, RequestOptions requestOptions)

Get a list of all update names that match the specified provider.

Response Body Schema

{
     value (Required): [
         String (Required)
     ]
     nextLink: String (Optional)
 }

Parameters:

Returns:

public PagedIterable listOperationStatuses(RequestOptions requestOptions)

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. |

You can add these to a request with RequestOptions#addQueryParam

Response Body Schema

{
     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)
         }
     ]
     nextLink: String (Optional)
 }

Parameters:

Returns:

public PagedIterable listProviders(RequestOptions requestOptions)

Get a list of all update providers that have been imported to Device Update for IoT Hub.

Response Body Schema

{
     value (Required): [
         String (Required)
     ]
     nextLink: String (Optional)
 }

Parameters:

Returns:

public PagedIterable listUpdates(RequestOptions requestOptions)

Get a list of all updates that have been imported to Device Update for IoT Hub.

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.    |

You can add these to a request with RequestOptions#addQueryParam

Response Body Schema

{
     value (Required): [
          (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){
                     String: String (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)
                     }
                 ]
             }
             referencedBy (Optional): [
                 (recursive schema, see above)
             ]
             scanResult: String (Optional)
             manifestVersion: String (Required)
             importedDateTime: OffsetDateTime (Required)
             createdDateTime: OffsetDateTime (Required)
             etag: String (Optional)
         }
     ]
     nextLink: String (Optional)
 }

Parameters:

Returns:

public PagedIterable listVersions(String provider, String name, RequestOptions requestOptions)

Get a list of all update versions that match the specified provider and name.

Query Parameters

| ------ | ------ | -------- | ---------------------------------------------------- |
| Name   | Type   | Required | Description                                          |
| filter | String | No       | Optional to filter updates by isDeployable property. |

You can add these to a request with RequestOptions#addQueryParam

Response Body Schema

{
     value (Required): [
         String (Required)
     ]
     nextLink: String (Optional)
 }

Parameters:

Returns: