MachineGroup interface

A user-defined logical grouping of machines.

Properties

count

Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle.

displayName

User defined name for the group

etag

Resource ETAG.

groupType

Type of the machine group. Possible values include: 'unknown', 'azure-cs', 'azure-sf', 'azure-vmss', 'user-static'

id

Resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

kind

Polymorphic Discriminator

machines

References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated.

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

count

Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle.

count?: number

Property Value

number

displayName

User defined name for the group

displayName: string

Property Value

string

etag

Resource ETAG.

etag?: string

Property Value

string

groupType

Type of the machine group. Possible values include: 'unknown', 'azure-cs', 'azure-sf', 'azure-vmss', 'user-static'

groupType?: MachineGroupType

Property Value

id

Resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

kind

Polymorphic Discriminator

kind: "machineGroup"

Property Value

"machineGroup"

machines

References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated.

machines?: MachineReferenceWithHints[]

Property Value

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string