DeviceUpdateOperations interface

Package:

@azure/iot-device-update

Interface representing a DeviceUpdate operations.

Properties

deleteUpdate	Delete a specific update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.
getFile	Get a specific update file from the version.
getOperationStatus	Retrieve operation status.
getUpdate	Get a specific update version.
importUpdate	Import new update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.
listFiles	Get a list of all update file identifiers for the specified version.
listNames	Get a list of all update names that match the specified provider.
listOperationStatuses	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.
listProviders	Get a list of all update providers that have been imported to Device Update for IoT Hub.
listUpdates	Get a list of all updates that have been imported to Device Update for IoT Hub.
listVersions	Get a list of all update versions that match the specified provider and name.

Property Details

deleteUpdate

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

deleteUpdate: (provider: string, name: string, version: string, options?: DeviceUpdateDeleteUpdateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(provider: string, name: string, version: string, options?: DeviceUpdateDeleteUpdateOptionalParams) => PollerLike<OperationState<void>, void>

getFile

Get a specific update file from the version.

getFile: (provider: string, name: string, version: string, fileId: string, options?: DeviceUpdateGetFileOptionalParams) => Promise<UpdateFile>

Property Value

(provider: string, name: string, version: string, fileId: string, options?: DeviceUpdateGetFileOptionalParams) => Promise<UpdateFile>

getOperationStatus

Retrieve operation status.

getOperationStatus: (operationId: string, options?: DeviceUpdateGetOperationStatusOptionalParams) => Promise<UpdateOperation>

Property Value

(operationId: string, options?: DeviceUpdateGetOperationStatusOptionalParams) => Promise<UpdateOperation>

getUpdate

Get a specific update version.

getUpdate: (provider: string, name: string, version: string, options?: DeviceUpdateGetUpdateOptionalParams) => Promise<Update>

Property Value

(provider: string, name: string, version: string, options?: DeviceUpdateGetUpdateOptionalParams) => Promise<Update>

importUpdate

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

importUpdate: (updateToImport: ImportUpdateInputItem[], options?: DeviceUpdateImportUpdateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(updateToImport: ImportUpdateInputItem[], options?: DeviceUpdateImportUpdateOptionalParams) => PollerLike<OperationState<void>, void>

listFiles

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

listFiles: (provider: string, name: string, version: string, options?: DeviceUpdateListFilesOptionalParams) => PagedAsyncIterableIterator<string, string[], PageSettings>

Property Value

(provider: string, name: string, version: string, options?: DeviceUpdateListFilesOptionalParams) => PagedAsyncIterableIterator<string, string[], PageSettings>

listNames

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

listNames: (provider: string, options?: DeviceUpdateListNamesOptionalParams) => PagedAsyncIterableIterator<string, string[], PageSettings>

Property Value

(provider: string, options?: DeviceUpdateListNamesOptionalParams) => PagedAsyncIterableIterator<string, string[], PageSettings>

listOperationStatuses

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.

listOperationStatuses: (options?: DeviceUpdateListOperationStatusesOptionalParams) => PagedAsyncIterableIterator<UpdateOperation, UpdateOperation[], PageSettings>

Property Value

(options?: DeviceUpdateListOperationStatusesOptionalParams) => PagedAsyncIterableIterator<UpdateOperation, UpdateOperation[], PageSettings>

listProviders

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

listProviders: (options?: DeviceUpdateListProvidersOptionalParams) => PagedAsyncIterableIterator<string, string[], PageSettings>

Property Value

(options?: DeviceUpdateListProvidersOptionalParams) => PagedAsyncIterableIterator<string, string[], PageSettings>

listUpdates

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

listUpdates: (options?: DeviceUpdateListUpdatesOptionalParams) => PagedAsyncIterableIterator<Update, Update[], PageSettings>

Property Value

(options?: DeviceUpdateListUpdatesOptionalParams) => PagedAsyncIterableIterator<Update, Update[], PageSettings>

listVersions

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

listVersions: (provider: string, name: string, options?: DeviceUpdateListVersionsOptionalParams) => PagedAsyncIterableIterator<string, string[], PageSettings>

Property Value

(provider: string, name: string, options?: DeviceUpdateListVersionsOptionalParams) => PagedAsyncIterableIterator<string, string[], PageSettings>