Class Updates

Package version

Class representing a Updates.

Hierarchy

Updates

Index

Constructors

constructor

Methods

Constructors

constructor

new Updates(client: DeviceUpdateClientContext): Updates

- Defined in operations/updates.ts:43
Initialize a new instance of the class Updates class.

Parameters
- client: DeviceUpdateClientContext
  
  Reference to the service client
Returns Updates

Methods

deleteUpdate

deleteUpdate(provider: string, name: string, version: string, options?: coreHttp.OperationOptions): Promise<UpdatesDeleteUpdateResponse>

- Defined in operations/updates.ts:367
Delete a specific update version.

Parameters
- provider: string
  
  Update provider.
- name: string
  
  Update name.
- version: string
  
  Update version.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<UpdatesDeleteUpdateResponse>

getFile

getFile(provider: string, name: string, version: string, fileId: string, options?: UpdatesGetFileOptionalParams): Promise<UpdatesGetFileResponse>

- Defined in operations/updates.ts:550
Get a specific update file from the version.

Parameters
- provider: string
  
  Update provider.
- name: string
  
  Update name.
- version: string
  
  Update version.
- fileId: string
  
  File identifier.
- Optional options: UpdatesGetFileOptionalParams
  
  The options parameters.
Returns Promise<UpdatesGetFileResponse>

getOperation

getOperation(operationId: string, options?: UpdatesGetOperationOptionalParams): Promise<UpdatesGetOperationResponse>

- Defined in operations/updates.ts:622
Retrieve operation status.

Parameters
- operationId: string
  
  Operation identifier.
- Optional options: UpdatesGetOperationOptionalParams
  
  The options parameters.
Returns Promise<UpdatesGetOperationResponse>

getUpdate

getUpdate(provider: string, name: string, version: string, options?: UpdatesGetUpdateOptionalParams): Promise<UpdatesGetUpdateResponse>

- Defined in operations/updates.ts:327
Get a specific update version.

Parameters
- provider: string
  
  Update provider.
- name: string
  
  Update name.
- version: string
  
  Update version.
- Optional options: UpdatesGetUpdateOptionalParams
  
  The options parameters.
Returns Promise<UpdatesGetUpdateResponse>

importUpdate

importUpdate(updateToImport: ImportUpdateInput, options?: coreHttp.OperationOptions): Promise<UpdatesImportUpdateResponse>

- Defined in operations/updates.ts:291
Import new update version.

Parameters
- updateToImport: ImportUpdateInput
  
  The update to be imported.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<UpdatesImportUpdateResponse>

listFiles

listFiles(provider: string, name: string, version: string, options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<string>

- Defined in operations/updates.ts:196
Get a list of all update file identifiers for the specified version.

Parameters
- provider: string
  
  Update provider.
- name: string
  
  Update name.
- version: string
  
  Update version.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<string>

listNames

listNames(provider: string, options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<string>

- Defined in operations/updates.ts:98
Get a list of all update names that match the specified provider.

Parameters
- provider: string
  
  Update provider.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<string>

listOperations

listOperations(options?: UpdatesGetOperationsOptionalParams): PagedAsyncIterableIterator<Operation>

- Defined in operations/updates.ts:248
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.

Parameters
- Optional options: UpdatesGetOperationsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Operation>

listProviders

listProviders(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<string>

- Defined in operations/updates.ts:57
Get a list of all update providers that have been imported to Device Update for IoT Hub.

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<string>

listVersions

listVersions(provider: string, name: string, options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<string>

- Defined in operations/updates.ts:145
Get a list of all update versions that match the specified provider and name.

Parameters
- provider: string
  
  Update provider.
- name: string
  
  Update name.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<string>

Generated using TypeDoc