DeviceClassSubgroupDeploymentStatusOutput interface

Package:

@azure-rest/iot-device-update

Device class subgroup deployment status metadata.

Properties

deploymentState	The state of the subgroup deployment.
deviceClassId	The device class subgroup identity
devicesCanceledCount	The number of devices which have had their deployment canceled.
devicesCompletedFailedCount	The number of devices that have completed deployment with a failure.
devicesCompletedSucceededCount	The number of devices which have successfully completed deployment.
devicesInProgressCount	The number of devices that are currently in deployment.
error	The error details of the Failed state. This is not present if the deployment state is not Failed.
groupId	The group identity
totalDevices	The total number of devices in the deployment.

Property Details

deploymentState

The state of the subgroup deployment.

deploymentState: "Failed" | "Canceled" | "Active" | "Inactive"

Property Value

"Failed" | "Canceled" | "Active" | "Inactive"

deviceClassId

The device class subgroup identity

deviceClassId: string

Property Value

string

devicesCanceledCount

The number of devices which have had their deployment canceled.

devicesCanceledCount?: number

Property Value

number

devicesCompletedFailedCount

The number of devices that have completed deployment with a failure.

devicesCompletedFailedCount?: number

Property Value

number

devicesCompletedSucceededCount

The number of devices which have successfully completed deployment.

devicesCompletedSucceededCount?: number

Property Value

number

devicesInProgressCount

The number of devices that are currently in deployment.

devicesInProgressCount?: number

Property Value

number

error

The error details of the Failed state. This is not present if the deployment state is not Failed.

error?: ErrorModelOutput

Property Value

ErrorModelOutput

groupId

The group identity

groupId: string

Property Value

string

totalDevices

The total number of devices in the deployment.

totalDevices?: number

Property Value

number