Sign in

v6

latestSwagger 2.02026-07-135076139.2 KB
Device and deployment management

Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress, completed, or failed.

get/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}/status

Path parameters

instanceIdstring required

The Device Update for IoT Hub account instance identifier.

groupIdstring required

Group identifier.

deviceClassIdstring required

Device class identifier.

deploymentIdstring required

Deployment identifier.

Query parameters

api-versionstring required

The API version to use for this operation.

Response

The request has succeeded.

groupIdstring required

The group identity

deviceClassIdstring required

The device class subgroup identity

deploymentState'Active' | 'Failed' | 'Inactive' | 'Canceled' required

Device class subgroup deployment state.

totalDevicesinteger

The total number of devices in the deployment.

devicesInProgressCountinteger

The number of devices that are currently in deployment.

devicesCompletedFailedCountinteger

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

devicesCompletedSucceededCountinteger

The number of devices which have successfully completed deployment.

devicesCanceledCountinteger

The number of devices which have had their deployment canceled.