Share via


GroupOutput interface

Group details.

Properties

createdDateTime

Date and time when the update was created.

deployments

The active deployment Ids for the group

deviceCount

The number of devices in the group.

groupId

Group identity. This is created from the value of the ADUGroup tag in the Iot Hub's device/module twin or $default for devices with no tag.

groupType

Group type.

subgroupsWithNewUpdatesAvailableCount

The count of subgroups with new updates available.

subgroupsWithOnLatestUpdateCount

The count of subgroups with devices on the latest update.

subgroupsWithUpdatesInProgressCount

The count of subgroups with updates in progress.

Property Details

createdDateTime

Date and time when the update was created.

createdDateTime: string

Property Value

string

deployments

The active deployment Ids for the group

deployments?: string[]

Property Value

string[]

deviceCount

The number of devices in the group.

deviceCount?: number

Property Value

number

groupId

Group identity. This is created from the value of the ADUGroup tag in the Iot Hub's device/module twin or $default for devices with no tag.

groupId: string

Property Value

string

groupType

Group type.

groupType: "IoTHubTag" | "DefaultNoTag"

Property Value

"IoTHubTag" | "DefaultNoTag"

subgroupsWithNewUpdatesAvailableCount

The count of subgroups with new updates available.

subgroupsWithNewUpdatesAvailableCount?: number

Property Value

number

subgroupsWithOnLatestUpdateCount

The count of subgroups with devices on the latest update.

subgroupsWithOnLatestUpdateCount?: number

Property Value

number

subgroupsWithUpdatesInProgressCount

The count of subgroups with updates in progress.

subgroupsWithUpdatesInProgressCount?: number

Property Value

number