Deployment interface

Package:

@azure-rest/iot-device-update

Deployment metadata.

Properties

deploymentId	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.
deviceClassSubgroups	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
groupId	The group identity for the devices the deployment is intended to update.
isCanceled	Boolean flag indicating whether the deployment was canceled.
isCloudInitiatedRollback	Boolean flag indicating whether the deployment is a rollback deployment.
isRetried	Boolean flag indicating whether the deployment has been retried.
rollbackPolicy	The rollback policy for the deployment.
startDateTime	The deployment start datetime.
update	Update information for the update in the deployment.

Property Details

deploymentId

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.

deploymentId: string

Property Value

string

deviceClassSubgroups

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

deviceClassSubgroups?: string[]

Property Value

string[]

groupId

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

groupId: string

Property Value

string

isCanceled

Boolean flag indicating whether the deployment was canceled.

isCanceled?: boolean

Property Value

boolean

isCloudInitiatedRollback

Boolean flag indicating whether the deployment is a rollback deployment.

isCloudInitiatedRollback?: boolean

Property Value

boolean

isRetried

Boolean flag indicating whether the deployment has been retried.

isRetried?: boolean

Property Value

boolean

rollbackPolicy

The rollback policy for the deployment.

rollbackPolicy?: CloudInitiatedRollbackPolicy

Property Value

CloudInitiatedRollbackPolicy

startDateTime

The deployment start datetime.

startDateTime: string | Date

Property Value

string | Date

update

Update information for the update in the deployment.

update: UpdateInfo

Property Value

UpdateInfo