共用方式為


@azure/iot-device-update package

Classes

DeviceUpdateClient
DeviceUpdateClientContext

Interfaces

AccessCondition

Parameter group

Compatibility

Update compatibility information.

Deployment

Deployment metadata.

DeploymentDeviceState

Deployment device status.

DeploymentDeviceStatesFilter

Deployment device state filter.

DeploymentFilter

Deployment filter.

DeploymentStatus

Deployment status metadata.

DeploymentsGetAllDeploymentsNextOptionalParams

Optional parameters.

DeploymentsGetAllDeploymentsOptionalParams

Optional parameters.

DeploymentsGetDeploymentDevicesNextOptionalParams

Optional parameters.

DeploymentsGetDeploymentDevicesOptionalParams

Optional parameters.

Device

Device metadata.

DeviceClass

Device class metadata.

DeviceFilter

Operation status filter.

DeviceTag

Device tag properties.

DeviceUpdateClientOptionalParams

Optional parameters.

DevicesGetAllDevicesNextOptionalParams

Optional parameters.

DevicesGetAllDevicesOptionalParams

Optional parameters.

DevicesGetGroupBestUpdatesNextOptionalParams

Optional parameters.

DevicesGetGroupBestUpdatesOptionalParams

Optional parameters.

ErrorModel

Error details.

File

Update file metadata.

FileImportMetadata

Metadata describing an update file.

Group

Group details.

GroupBestUpdatesFilter

Group best updates filter.

ImportManifestMetadata

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

ImportUpdateInput

Import update input metadata.

InnerError

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

Operation

Operation metadata.

OperationFilter

Operation status filter.

PageableListOfDeploymentDeviceStates

The list of deployment device states.

PageableListOfDeployments

The list of deployments.

PageableListOfDeviceClasses

The list of device classes.

PageableListOfDeviceTags

The list of device tags.

PageableListOfDevices

The list of devices.

PageableListOfGroups

The list of groups.

PageableListOfOperations

The list of operations with server paging support.

PageableListOfStrings

The list of strings with server paging support.

PageableListOfUpdatableDevices

The list of updatable devices.

PageableListOfUpdateIds

The list of update identities.

UpdatableDevices

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

Update

Update metadata.

UpdateCompliance

Update compliance information.

UpdateId

Update identifier.

UpdatesDeleteUpdateHeaders

Defines headers for Updates_deleteUpdate operation.

UpdatesGetFileOptionalParams

Optional parameters.

UpdatesGetOperationHeaders

Defines headers for Updates_getOperation operation.

UpdatesGetOperationOptionalParams

Optional parameters.

UpdatesGetOperationsNextOptionalParams

Optional parameters.

UpdatesGetOperationsOptionalParams

Optional parameters.

UpdatesGetUpdateOptionalParams

Optional parameters.

UpdatesImportUpdateHeaders

Defines headers for Updates_importUpdate operation.

Type Aliases

DeploymentState

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.

DeploymentType

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.

DeploymentsCancelDeploymentResponse

Contains response data for the cancelDeployment operation.

DeploymentsCreateOrUpdateDeploymentResponse

Contains response data for the createOrUpdateDeployment operation.

DeploymentsGetAllDeploymentsNextResponse

Contains response data for the getAllDeploymentsNext operation.

DeploymentsGetAllDeploymentsResponse

Contains response data for the getAllDeployments operation.

DeploymentsGetDeploymentDevicesNextResponse

Contains response data for the getDeploymentDevicesNext operation.

DeploymentsGetDeploymentDevicesResponse

Contains response data for the getDeploymentDevices operation.

DeploymentsGetDeploymentResponse

Contains response data for the getDeployment operation.

DeploymentsGetDeploymentStatusResponse

Contains response data for the getDeploymentStatus operation.

DeploymentsRetryDeploymentResponse

Contains response data for the retryDeployment operation.

DeviceDeploymentState

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.

DeviceGroupType

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.

DeviceState

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.

DevicesCreateOrUpdateGroupResponse

Contains response data for the createOrUpdateGroup operation.

DevicesGetAllDeviceClassesNextResponse

Contains response data for the getAllDeviceClassesNext operation.

DevicesGetAllDeviceClassesResponse

Contains response data for the getAllDeviceClasses operation.

DevicesGetAllDeviceTagsNextResponse

Contains response data for the getAllDeviceTagsNext operation.

DevicesGetAllDeviceTagsResponse

Contains response data for the getAllDeviceTags operation.

DevicesGetAllDevicesNextResponse

Contains response data for the getAllDevicesNext operation.

DevicesGetAllDevicesResponse

Contains response data for the getAllDevices operation.

DevicesGetAllGroupsNextResponse

Contains response data for the getAllGroupsNext operation.

DevicesGetAllGroupsResponse

Contains response data for the getAllGroups operation.

DevicesGetDeviceClassDeviceIdsNextResponse

Contains response data for the getDeviceClassDeviceIdsNext operation.

DevicesGetDeviceClassDeviceIdsResponse

Contains response data for the getDeviceClassDeviceIds operation.

DevicesGetDeviceClassInstallableUpdatesNextResponse

Contains response data for the getDeviceClassInstallableUpdatesNext operation.

DevicesGetDeviceClassInstallableUpdatesResponse

Contains response data for the getDeviceClassInstallableUpdates operation.

DevicesGetDeviceClassResponse

Contains response data for the getDeviceClass operation.

DevicesGetDeviceResponse

Contains response data for the getDevice operation.

DevicesGetDeviceTagResponse

Contains response data for the getDeviceTag operation.

DevicesGetGroupBestUpdatesNextResponse

Contains response data for the getGroupBestUpdatesNext operation.

DevicesGetGroupBestUpdatesResponse

Contains response data for the getGroupBestUpdates operation.

DevicesGetGroupResponse

Contains response data for the getGroup operation.

DevicesGetGroupUpdateComplianceResponse

Contains response data for the getGroupUpdateCompliance operation.

DevicesGetUpdateComplianceResponse

Contains response data for the getUpdateCompliance operation.

GroupType

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.

OperationFilterStatus

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

OperationStatus

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.

UpdatesDeleteUpdateResponse

Contains response data for the deleteUpdate operation.

UpdatesGetFileResponse

Contains response data for the getFile operation.

UpdatesGetFilesNextResponse

Contains response data for the getFilesNext operation.

UpdatesGetFilesResponse

Contains response data for the getFiles operation.

UpdatesGetNamesNextResponse

Contains response data for the getNamesNext operation.

UpdatesGetNamesResponse

Contains response data for the getNames operation.

UpdatesGetOperationResponse

Contains response data for the getOperation operation.

UpdatesGetOperationsNextResponse

Contains response data for the getOperationsNext operation.

UpdatesGetOperationsResponse

Contains response data for the getOperations operation.

UpdatesGetProvidersNextResponse

Contains response data for the getProvidersNext operation.

UpdatesGetProvidersResponse

Contains response data for the getProviders operation.

UpdatesGetUpdateResponse

Contains response data for the getUpdate operation.

UpdatesGetVersionsNextResponse

Contains response data for the getVersionsNext operation.

UpdatesGetVersionsResponse

Contains response data for the getVersions operation.

UpdatesImportUpdateResponse

Contains response data for the importUpdate operation.

Enums

KnownDeploymentState

Known values of DeploymentState that the service accepts.

KnownDeploymentType

Known values of DeploymentType that the service accepts.

KnownDeviceDeploymentState

Known values of DeviceDeploymentState that the service accepts.

KnownDeviceGroupType

Known values of DeviceGroupType that the service accepts.

KnownDeviceState

Known values of DeviceState that the service accepts.

KnownGroupType

Known values of GroupType that the service accepts.

KnownOperationFilterStatus

Known values of OperationFilterStatus that the service accepts.

KnownOperationStatus

Known values of OperationStatus that the service accepts.