@azure/iot-device-update package

Parameter group

Update compatibility information.

Deployment metadata.

Deployment device status.

Deployment device state filter.

Deployment filter.

Deployment status metadata.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Device metadata.

Device class metadata.

Operation status filter.

Device tag properties.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Error details.

Update file metadata.

Metadata describing an update file.

Group details.

Group best updates filter.

Metadata describing the import manifest, a document which describes the files and other metadata about an update version.

Import update input metadata.

An object containing more specific information than the current object about the error.

Operation metadata.

Operation status filter.

The list of deployment device states.

The list of deployments.

The list of device classes.

The list of device tags.

The list of devices.

The list of groups.

The list of operations with server paging support.

The list of strings with server paging support.

The list of updatable devices.

The list of update identities.

Update identifier and the number of devices for which the update is applicable.

Update metadata.

Update compliance information.

Update identifier.

Defines headers for Updates_deleteUpdate operation.

Optional parameters.

Defines headers for Updates_getOperation operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for Updates_importUpdate operation.

Defines values for DeploymentState.
KnownDeploymentState can be used interchangeably with DeploymentState, this enum contains the known values that the service supports.

Know values supported by the service

Active: The deployment can be sent to devices targeted in the deployment.
Superseded: A newer deployment with the same targeting exists and no devices will receive this deployment.
Canceled: The deployment has been canceled and no devices will receive it.

Defines values for DeploymentType.
KnownDeploymentType can be used interchangeably with DeploymentType, this enum contains the known values that the service supports.

Know values supported by the service

Complete: A complete deployment including download, install, and apply actions.
Download: A download-only deployment that does not include any install or apply actions. Not currently supported.
Install: An install-only rollout that does not include any download actions, only install and complete. Not currently supported.

Contains response data for the cancelDeployment operation.

Contains response data for the createOrUpdateDeployment operation.

Contains response data for the getAllDeploymentsNext operation.

Contains response data for the getAllDeployments operation.

Contains response data for the getDeploymentDevicesNext operation.

Contains response data for the getDeploymentDevices operation.

Contains response data for the getDeployment operation.

Contains response data for the getDeploymentStatus operation.

Contains response data for the retryDeployment operation.

Defines values for DeviceDeploymentState.
KnownDeviceDeploymentState can be used interchangeably with DeviceDeploymentState, this enum contains the known values that the service supports.

Know values supported by the service

Succeeded: Deployment has completed with success.
InProgress: Deployment is in progress.
Failed: Deployment has completed with failure.
Canceled: Deployment was canceled.
Incompatible: Deployment is not compatible with the device.

Defines values for DeviceGroupType.
KnownDeviceGroupType can be used interchangeably with DeviceGroupType, this enum contains the known values that the service supports.

Know values supported by the service

All: The deployment should be sent to all devices in the device class.
Devices: The deployment should be sent to the list of devices in the device group definition.
DeviceGroupDefinitions: The deployment should be sent to the list of devices returned by the union of all the device group definition queries.

Defines values for DeviceState.
KnownDeviceState can be used interchangeably with DeviceState, this enum contains the known values that the service supports.

Know values supported by the service

NotStarted: Not started (or uninitialized)
Incompatible: Deployment incompatible for this device.
AlreadyInDeployment: Another Deployment is underway for this device.
Canceled: Deployment has been canceled for this device.
InProgress: Deployment underway.
Failed: Deployment failed.
Succeeded: Deployment completed successfully.

Contains response data for the createOrUpdateGroup operation.

Contains response data for the getAllDeviceClassesNext operation.

Contains response data for the getAllDeviceClasses operation.

Contains response data for the getAllDeviceTagsNext operation.

Contains response data for the getAllDeviceTags operation.

Contains response data for the getAllDevicesNext operation.

Contains response data for the getAllDevices operation.

Contains response data for the getAllGroupsNext operation.

Contains response data for the getAllGroups operation.

Contains response data for the getDeviceClassDeviceIdsNext operation.

Contains response data for the getDeviceClassDeviceIds operation.

Contains response data for the getDeviceClassInstallableUpdatesNext operation.

Contains response data for the getDeviceClassInstallableUpdates operation.

Contains response data for the getDeviceClass operation.

Contains response data for the getDevice operation.

Contains response data for the getDeviceTag operation.

Contains response data for the getGroupBestUpdatesNext operation.

Contains response data for the getGroupBestUpdates operation.

Contains response data for the getGroup operation.

Contains response data for the getGroupUpdateCompliance operation.

Contains response data for the getUpdateCompliance operation.

Defines values for GroupType.
KnownGroupType can be used interchangeably with GroupType, this enum contains the known values that the service supports.

Know values supported by the service

IoTHubTag: IoT Hub tag based group.

Defines values for OperationFilterStatus.
KnownOperationFilterStatus can be used interchangeably with OperationFilterStatus, this enum contains the known values that the service supports.

Know values supported by the service

Running
NotStarted

Defines values for OperationStatus.
KnownOperationStatus can be used interchangeably with OperationStatus, this enum contains the known values that the service supports.

Know values supported by the service

Undefined: Undefined operation status.
NotStarted: Background operation created but not started yet.
Running: Background operation is currently running.
Succeeded: Background operation finished with success.
Failed: Background operation finished with failure.

Contains response data for the deleteUpdate operation.

Contains response data for the getFile operation.

Contains response data for the getFilesNext operation.

Contains response data for the getFiles operation.

Contains response data for the getNamesNext operation.

Contains response data for the getNames operation.

Contains response data for the getOperation operation.

Contains response data for the getOperationsNext operation.

Contains response data for the getOperations operation.

Contains response data for the getProvidersNext operation.

Contains response data for the getProviders operation.

Contains response data for the getUpdate operation.

Contains response data for the getVersionsNext operation.

Contains response data for the getVersions operation.

Contains response data for the importUpdate operation.

Known values of DeploymentState that the service accepts.

Known values of DeploymentType that the service accepts.

Known values of DeviceDeploymentState that the service accepts.

Known values of DeviceGroupType that the service accepts.

Known values of DeviceState that the service accepts.

Known values of GroupType that the service accepts.

Known values of OperationFilterStatus that the service accepts.

Known values of OperationStatus that the service accepts.