DesktopGroupProps

Properties for defining a DesktopGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecd-desktopgroup

Initializer

using AlibabaCloud.SDK.ROS.CDK.Ecd;
new DesktopGroupProps {
    object BundleId,
    object ChargeType,
    object OfficeSiteId,
    object PolicyGroupId,
    object AllowAutoSetup = null,
    object AllowBufferCount = null,
    object AutoPay = null,
    object AutoRenew = null,
    object BuyDesktopsCount = null,
    object Comments = null,
    object ConnectDuration = null,
    object DefaultInitDesktopCount = null,
    object DesktopGroupName = null,
    object EndUserIds = null,
    object GroupVersion = null,
    object IdleDisconnectDuration = null,
    object KeepDuration = null,
    object MaxDesktopsCount = null,
    object MinDesktopsCount = null,
    object Period = null,
    object PeriodUnit = null,
    object ResetType = null,
    object StopDuration = null,
    object VolumeEncryptionEnabled = null,
    object VolumeEncryptionKey = null
};

Properties

Name	Type	Description
BundleId	object	Property bundleId: The ID of the desktop template.
ChargeType	object	Property chargeType: The billing method of the cloud desktops in the desktop group.
OfficeSiteId	object	Property officeSiteId: The ID of the workspace.
PolicyGroupId	object	Property policyGroupId: The ID of the policy.
AllowAutoSetup	object	Property allowAutoSetup: Specifies whether to automatically create cloud desktops in the desktop group if you set the billing method to subscription.
AllowBufferCount	object	Property allowBufferCount: Specifies whether to reserve cloud desktops if you set the billing method to pay-as-you-go.
AutoPay	object	Property autoPay: Specifies whether to enable automatic payment.
AutoRenew	object	Property autoRenew: Specifies whether to enable auto-renewal.
BuyDesktopsCount	object	Property buyDesktopsCount: The number of cloud desktops that you want to purchase.
Comments	object	Property comments: The remarks on the desktop group.
ConnectDuration	object	Property connectDuration: The maximum period of time during which the session is connected.
DefaultInitDesktopCount	object	Property defaultInitDesktopCount: The default number of cloud desktops to create when you create the desktop group.
DesktopGroupName	object	Property desktopGroupName: The name of the desktop group.
EndUserIds	object	Property endUserIds: The end users that can use the desktop group.
GroupVersion	object	Property groupVersion: The desktop group version.
IdleDisconnectDuration	object	Property idleDisconnectDuration: The maximum period of time for which a session remains idle.
KeepDuration	object	Property keepDuration: The retention period of the cloud desktop after the end user disconnects from the cloud desktop.
MaxDesktopsCount	object	Property maxDesktopsCount: The maximum number of cloud desktops that the desktop group can contain.
MinDesktopsCount	object	Property minDesktopsCount: The minimum number of cloud desktops that must be contained in the desktop group if you set the billing method to subscription.
Period	object	Property period: The subscription period of the cloud desktops in the desktop group.
PeriodUnit	object	Property periodUnit: Whether to open CA.
ResetType	object	Property resetType: Specifies which type of the disk to reset for cloud desktops in the desktop group.
StopDuration	object	Property stopDuration: The period of time before the idle cloud desktop is stopped.
VolumeEncryptionEnabled	object	Property volumeEncryptionEnabled: Specifies whether to enable disk encryption.
VolumeEncryptionKey	object	Property volumeEncryptionKey: The ID of the Key Management Service (KMS) key that you want to use when disk encryption is enabled.

---

BundleId^Required

public object BundleId { get; set; }

• Type: object

Property bundleId: The ID of the desktop template.

---

ChargeType^Required

public object ChargeType { get; set; }

• Type: object

Property chargeType: The billing method of the cloud desktops in the desktop group.

Enumeration Value: PostPaid PrePaid

---

OfficeSiteId^Required

public object OfficeSiteId { get; set; }

• Type: object

Property officeSiteId: The ID of the workspace.

---

PolicyGroupId^Required

public object PolicyGroupId { get; set; }

• Type: object

Property policyGroupId: The ID of the policy.

---

AllowAutoSetup^Optional

public object AllowAutoSetup { get; set; }

• Type: object

Property allowAutoSetup: Specifies whether to automatically create cloud desktops in the desktop group if you set the billing method to subscription.

If you set the ChargeType parameter to PrePaid, this parameter is required.

---

AllowBufferCount^Optional

public object AllowBufferCount { get; set; }

• Type: object

Property allowBufferCount: Specifies whether to reserve cloud desktops if you set the billing method to pay-as-you-go.

If you set the ChargeType parameter to PostPaid, this parameter is required. Valid values: 0: does not allow the system to reserve cloud desktops. N: allows the system to reserve N cloud desktops. The variable N must be an integer that ranges from 1 to 100.

---

AutoPay^Optional

public object AutoPay { get; set; }

• Type: object

Property autoPay: Specifies whether to enable automatic payment.

---

AutoRenew^Optional

public object AutoRenew { get; set; }

• Type: object

Property autoRenew: Specifies whether to enable auto-renewal.

---

BuyDesktopsCount^Optional

public object BuyDesktopsCount { get; set; }

• Type: object

Property buyDesktopsCount: The number of cloud desktops that you want to purchase.

Valid values: 0 to 200.

---

Comments^Optional

public object Comments { get; set; }

• Type: object

Property comments: The remarks on the desktop group.

---

ConnectDuration^Optional

public object ConnectDuration { get; set; }

• Type: object

Property connectDuration: The maximum period of time during which the session is connected.

When the specified maximum period of time is reached, the session automatically disconnects. Unit: milliseconds. This parameter is required only for cloud desktops in the same desktop group.

---

DefaultInitDesktopCount^Optional

public object DefaultInitDesktopCount { get; set; }

• Type: object

Property defaultInitDesktopCount: The default number of cloud desktops to create when you create the desktop group.

Default value: 1.

---

DesktopGroupName^Optional

public object DesktopGroupName { get; set; }

• Type: object

Property desktopGroupName: The name of the desktop group.

---

EndUserIds^Optional

public object EndUserIds { get; set; }

• Type: object

Property endUserIds: The end users that can use the desktop group.

---

GroupVersion^Optional

public object GroupVersion { get; set; }

• Type: object

Property groupVersion: The desktop group version.

---

IdleDisconnectDuration^Optional

public object IdleDisconnectDuration { get; set; }

• Type: object

Property idleDisconnectDuration: The maximum period of time for which a session remains idle.

If an end user performs no operations on a cloud desktop by using keyboards or mouses during a session, the session becomes idle. When the specified maximum period of time is reached, the session automatically disconnects. Unit: milliseconds. This parameter is required only for cloud desktops in the same desktop group.

---

KeepDuration^Optional

public object KeepDuration { get; set; }

• Type: object

Property keepDuration: The retention period of the cloud desktop after the end user disconnects from the cloud desktop.

Unit: milliseconds.

---

MaxDesktopsCount^Optional

public object MaxDesktopsCount { get; set; }

• Type: object

Property maxDesktopsCount: The maximum number of cloud desktops that the desktop group can contain.

Valid values: 0 to 200.

---

MinDesktopsCount^Optional

public object MinDesktopsCount { get; set; }

• Type: object

Property minDesktopsCount: The minimum number of cloud desktops that must be contained in the desktop group if you set the billing method to subscription.

If you set the ChargeType parameter to PrePaid, this parameter is required. Valid values: 0 to the value of MaxDesktopsCount. Default value: 1.

---

Period^Optional

public object Period { get; set; }

• Type: object

Property period: The subscription period of the cloud desktops in the desktop group.

The unit is specified by the PeriodUnit parameter. The Period parameter takes effect only if you set the ChargeType parameter to PrePaid. Valid values if you set the PeriodUnit parameter to Month: 1, 2, 3, 6 Valid values if you set the PeriodUnit parameter to Year: 1, 2, 3, 4, 5

---

PeriodUnit^Optional

public object PeriodUnit { get; set; }

• Type: object

Property periodUnit: Whether to open CA.

---

ResetType^Optional

public object ResetType { get; set; }

• Type: object

Property resetType: Specifies which type of the disk to reset for cloud desktops in the desktop group.

---

StopDuration^Optional

public object StopDuration { get; set; }

• Type: object

Property stopDuration: The period of time before the idle cloud desktop is stopped.

When the specified period of time is reached, the idle cloud desktop automatically stops. If an end user connects to a stopped cloud desktop, the cloud desktop automatically starts. Unit: milliseconds.

---

VolumeEncryptionEnabled^Optional

public object VolumeEncryptionEnabled { get; set; }

• Type: object

Property volumeEncryptionEnabled: Specifies whether to enable disk encryption.

---

VolumeEncryptionKey^Optional

public object VolumeEncryptionKey { get; set; }

• Type: object

Property volumeEncryptionKey: The ID of the Key Management Service (KMS) key that you want to use when disk encryption is enabled.

---