Sign in

v6

latestSwagger 2.02026-07-135076139.2 KB
Device and deployment management

Creates or updates a deployment.

put/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}

Path parameters

instanceIdstring required

The Device Update for IoT Hub account instance identifier.

groupIdstring required

Group identifier.

deploymentIdstring required

Deployment identifier.

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

deploymentIdstring required

The caller-provided deployment identifier. This cannot be longer than 73 characters, must be all lower-case, and cannot contain '&', '^', '[', ']', '{', '}', '|', '<', '>', forward slash, backslash, or double quote. The Updates view in the Azure Portal IoT Hub resource generates a GUID for deploymentId when you create a deployment.

startDateTimestring date-time required

The deployment start datetime.

groupIdstring required

The group identity for the devices the deployment is intended to update.

deviceClassSubgroupsstring[]

The device class subgroups the deployment is compatible with and subgroup deployments have been created for. This is not provided by the caller during CreateOrUpdateDeployment but is automatically determined by Device Update

isCanceledboolean

Boolean flag indicating whether the deployment was canceled.

isRetriedboolean

Boolean flag indicating whether the deployment has been retried.

isCloudInitiatedRollbackboolean

Boolean flag indicating whether the deployment is a rollback deployment.

downloadSecurity'https' | 'http'

The protocol the device should use when downloading the update payload. Defaults to "https".

Response

The request has succeeded.

deploymentIdstring required

The caller-provided deployment identifier. This cannot be longer than 73 characters, must be all lower-case, and cannot contain '&', '^', '[', ']', '{', '}', '|', '<', '>', forward slash, backslash, or double quote. The Updates view in the Azure Portal IoT Hub resource generates a GUID for deploymentId when you create a deployment.

startDateTimestring date-time required

The deployment start datetime.

groupIdstring required

The group identity for the devices the deployment is intended to update.

deviceClassSubgroupsstring[]

The device class subgroups the deployment is compatible with and subgroup deployments have been created for. This is not provided by the caller during CreateOrUpdateDeployment but is automatically determined by Device Update

isCanceledboolean

Boolean flag indicating whether the deployment was canceled.

isRetriedboolean

Boolean flag indicating whether the deployment has been retried.

isCloudInitiatedRollbackboolean

Boolean flag indicating whether the deployment is a rollback deployment.

downloadSecurity'https' | 'http'

The protocol the device should use when downloading the update payload. Defaults to "https".