@azure/iot-device-update package

Classes

DeviceUpdateClient

Interfaces

CloudInitiatedRollbackPolicy	Rollback policy for deployment
CloudInitiatedRollbackPolicyFailure	Failure conditions to initiate rollback policy
Compatibility	Key-value pairs representing update compatibility information.
ContractModel	The Device Update agent contract model.
Deployment	Deployment metadata.
DeploymentDeviceState	Deployment device status.
DeploymentStatus	Deployment status metadata.
Device	Device metadata.
DeviceClass	Device class metadata.
DeviceClassProperties	The device class properties that are used to calculate the device class Id
DeviceClassSubgroup	Device class subgroup details. A device class subgroup is a subset of devices in a group that share the same device class id.
DeviceClassSubgroupDeploymentStatus	Device class subgroup deployment status metadata.
DeviceClassSubgroupUpdatableDevices	Device class subgroup, update information, and the number of devices for which the update is applicable.
DeviceHealth	Device Health
DeviceManagementCreateOrUpdateDeploymentOptionalParams	Optional parameters.
DeviceManagementDeleteDeploymentForDeviceClassSubgroupOptionalParams	Optional parameters.
DeviceManagementDeleteDeploymentOptionalParams	Optional parameters.
DeviceManagementDeleteDeviceClassOptionalParams	Optional parameters.
DeviceManagementDeleteDeviceClassSubgroupOptionalParams	Optional parameters.
DeviceManagementDeleteGroupOptionalParams	Optional parameters.
DeviceManagementGetBestUpdatesForDeviceClassSubgroupOptionalParams	Optional parameters.
DeviceManagementGetDeploymentForDeviceClassSubgroupOptionalParams	Optional parameters.
DeviceManagementGetDeploymentOptionalParams	Optional parameters.
DeviceManagementGetDeploymentStatusOptionalParams	Optional parameters.
DeviceManagementGetDeviceClassOptionalParams	Optional parameters.
DeviceManagementGetDeviceClassSubgroupDeploymentStatusOptionalParams	Optional parameters.
DeviceManagementGetDeviceClassSubgroupOptionalParams	Optional parameters.
DeviceManagementGetDeviceClassSubgroupUpdateComplianceOptionalParams	Optional parameters.
DeviceManagementGetDeviceModuleOptionalParams	Optional parameters.
DeviceManagementGetDeviceOptionalParams	Optional parameters.
DeviceManagementGetGroupOptionalParams	Optional parameters.
DeviceManagementGetLogCollectionDetailedStatusOptionalParams	Optional parameters.
DeviceManagementGetLogCollectionOptionalParams	Optional parameters.
DeviceManagementGetOperationStatusOptionalParams	Optional parameters.
DeviceManagementGetUpdateComplianceForGroupOptionalParams	Optional parameters.
DeviceManagementGetUpdateComplianceOptionalParams	Optional parameters.
DeviceManagementImportDevicesOptionalParams	Optional parameters.
DeviceManagementListBestUpdatesForGroupOptionalParams	Optional parameters.
DeviceManagementListDeploymentsForDeviceClassSubgroupOptionalParams	Optional parameters.
DeviceManagementListDeploymentsForGroupOptionalParams	Optional parameters.
DeviceManagementListDeviceClassSubgroupsForGroupOptionalParams	Optional parameters.
DeviceManagementListDeviceClassesOptionalParams	Optional parameters.
DeviceManagementListDeviceStatesForDeviceClassSubgroupDeploymentOptionalParams	Optional parameters.
DeviceManagementListDevicesOptionalParams	Optional parameters.
DeviceManagementListGroupsOptionalParams	Optional parameters.
DeviceManagementListHealthOfDevicesOptionalParams	Optional parameters.
DeviceManagementListInstallableUpdatesForDeviceClassOptionalParams	Optional parameters.
DeviceManagementListLogCollectionsOptionalParams	Optional parameters.
DeviceManagementListOperationStatusesOptionalParams	Optional parameters.
DeviceManagementOperations	Interface representing a DeviceManagement operations.
DeviceManagementRetryDeploymentOptionalParams	Optional parameters.
DeviceManagementStartLogCollectionOptionalParams	Optional parameters.
DeviceManagementStopDeploymentOptionalParams	Optional parameters.
DeviceManagementUpdateDeviceClassOptionalParams	Optional parameters.
DeviceOperation	Operation metadata.
DeviceUpdateAgentId	Device Update agent id
DeviceUpdateClientOptionalParams	Optional parameters for the client.
DeviceUpdateDeleteUpdateOptionalParams	Optional parameters.
DeviceUpdateGetFileOptionalParams	Optional parameters.
DeviceUpdateGetOperationStatusOptionalParams	Optional parameters.
DeviceUpdateGetUpdateOptionalParams	Optional parameters.
DeviceUpdateImportUpdateOptionalParams	Optional parameters.
DeviceUpdateListFilesOptionalParams	Optional parameters.
DeviceUpdateListNamesOptionalParams	Optional parameters.
DeviceUpdateListOperationStatusesOptionalParams	Optional parameters.
DeviceUpdateListProvidersOptionalParams	Optional parameters.
DeviceUpdateListUpdatesOptionalParams	Optional parameters.
DeviceUpdateListVersionsOptionalParams	Optional parameters.
DeviceUpdateOperations	Interface representing a DeviceUpdate operations.
ErrorModel	Error details.
ErrorResponse	Common error response.
FileImportMetadata	Metadata describing an update file.
Group	Group details.
HealthCheck	Health check
ImportManifestMetadata	Metadata describing the import manifest, a document which describes the files and other metadata about an update version.
ImportUpdateInputItem	Import update input item metadata.
InnerError	An object containing more specific information than the current object about the error.
InstallResult	The install result of an update and any step results under it.
Instructions	Update install instructions container.
LogCollection	Diagnostics request body
LogCollectionOperationDetailedStatus	Device diagnostics operation detailed status
LogCollectionOperationDeviceStatus	Diagnostics operation device status
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PatchBody	Device Class JSON Merge Patch request body
RestorePollerOptions
Step	Update install instruction step.
StepResult	The step result under an update.
Update	Update metadata.
UpdateCompliance	Update compliance information.
UpdateFile	Update file metadata.
UpdateFileBase	Update file basic metadata.
UpdateFileDownloadHandler	Download handler for utilizing related files to download payload file.
UpdateId	Update identifier.
UpdateInfo	Update information.
UpdateOperation	Operation metadata.

Type Aliases

ContinuablePage	An interface that describes a page of results.
DeploymentState	Deployment state.
DeviceClassSubgroupDeploymentState	Device class subgroup deployment state.
DeviceDeploymentState	Deployment state.
DeviceHealthState	Device health states
DownloadSecurity	The protocol the device should use when downloading the update payload.
GroupType	Supported group types.
HealthCheckResult	Health check result
ImportType	The device import type.
OperationStatus	Operation status.
StepType	Step type.

Enums

KnownVersions

The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(DeviceUpdateClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: DeviceUpdateClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

DeviceUpdateClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor