Deployment interface

Package:

@azure/iot-device-update

Deployment metadata.

Properties

deploymentId	Gets or sets the deployment identifier.
deploymentType	Gets or sets the deployment type.
deviceClassId	Gets or sets the device class identifier.
deviceGroupDefinition	Gets or sets the device group definition.
deviceGroupType	Gets or sets the device group type.
isCanceled	Boolean flag indicating whether the deployment was canceled.
isCompleted	Boolean flag indicating whether the deployment was completed.
isRetried	Boolean flag indicating whether the deployment has been retried.
startDateTime	Gets or sets the Deployment start datetime.
updateId	Update identity.

Property Details

deploymentId

Gets or sets the deployment identifier.

deploymentId: string

Property Value

string

deploymentType

Gets or sets the deployment type.

deploymentType: string

Property Value

string

deviceClassId

Gets or sets the device class identifier.

deviceClassId?: string

Property Value

string

deviceGroupDefinition

Gets or sets the device group definition.

deviceGroupDefinition: string[]

Property Value

string[]

deviceGroupType

Gets or sets the device group type.

deviceGroupType: string

Property Value

string

isCanceled

Boolean flag indicating whether the deployment was canceled.

isCanceled?: boolean

Property Value

boolean

isCompleted

Boolean flag indicating whether the deployment was completed.

isCompleted?: boolean

Property Value

boolean

isRetried

Boolean flag indicating whether the deployment has been retried.

isRetried?: boolean

Property Value

boolean

startDateTime

Gets or sets the Deployment start datetime.

startDateTime: Date

Property Value

Date

updateId

Update identity.

updateId: UpdateId

Property Value

UpdateId