DesktopsProps

Properties for defining a Desktops.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Ecd;
new DesktopsProps {
    object BundleId,
    object OfficeSiteId,
    object PolicyGroupId,
    object Amount = null,
    object AutoPay = null,
    object AutoRenew = null,
    object ChargeType = null,
    object DesktopName = null,
    object DesktopNameSuffix = null,
    object DirectoryId = null,
    object EndUserId = null,
    object GroupId = null,
    object Hostname = null,
    object Period = null,
    object PeriodUnit = null,
    object PromotionId = null,
    TagsProperty[] Tags = null,
    object UserAssignMode = null,
    object UserName = null,
    object VolumeEncryptionEnabled = null,
    object VolumeEncryptionKey = null,
    object VpcId = null
};

Properties

Name	Type	Description
BundleId	object	Property bundleId: The ID of the cloud desktop template.
OfficeSiteId	object	Property officeSiteId: The ID of the workspace.
PolicyGroupId	object	Property policyGroupId: The ID of the policy.
Amount	object	Property amount: The number of cloud desktops that you want to create.
AutoPay	object	Property autoPay: Specifies whether to enable automatic payment.
AutoRenew	object	Property autoRenew: Specifies whether to enable auto-renewal for the cloud desktop.
ChargeType	object	Property chargeType: The billing method of the cloud desktop.
DesktopName	object	Property desktopName: The name of the cloud desktop.
DesktopNameSuffix	object	Property desktopNameSuffix: Specifies whether to automatically add a suffix to the cloud desktop name when you create multiple cloud desktops at a time.
DirectoryId	object	Property directoryId: This parameter is not open for use.
EndUserId	object	Property endUserId: The user ID that authorizes the use of the cloud desktop, 1~100 can be set.
GroupId	object	Property groupId: desktop group ID。 Note that the desktop group function is currently in the invitation test.
Hostname	object	Property hostname: The custom hostname that you specify for the cloud desktop.
Period	object	Property period: The subscription duration.
PeriodUnit	object	Property periodUnit: The unit of the subscription duration.
PromotionId	object	Property promotionId: promotion id.
Tags	TagsProperty[]	Property tags: The list of desktops tags in the form of key\/value pairs.
UserAssignMode	object	Property userAssignMode: The assignment mode of the cloud desktop.
UserName	object	Property userName: This parameter is not open for use.
VolumeEncryptionEnabled	object	Property volumeEncryptionEnabled: Whether to enable disk encryption.
VolumeEncryptionKey	object	Property volumeEncryptionKey: The key ID of the KMS used when disk encryption is enabled.
VpcId	object	Property vpcId: This parameter is not open for use.

---

BundleId^Required

public object BundleId { get; set; }

• Type: object

Property bundleId: The ID of the cloud desktop template.

---

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.

---

Amount^Optional

public object Amount { get; set; }

• Type: object

Property amount: The number of cloud desktops that you want to create.

Valid values: 1 to 300. Default value: 1.

---

AutoPay^Optional

public object AutoPay { get; set; }

• Type: object

Property autoPay: Specifies whether to enable automatic payment.

Valid values: true: enables automatic payment. You must make sure that your Alibaba Cloud account has sufficient balance. If your Alibaba Cloud account does not have sufficient balance, abnormal orders are generated. false: disables automatic payment. In this case, an order is generated, and no payment is automatically made. You can log on to the EDS console and complete the payment based on the order ID on the Orders page. Default value: true.

---

AutoRenew^Optional

public object AutoRenew { get; set; }

• Type: object

Property autoRenew: Specifies whether to enable auto-renewal for the cloud desktop.

This parameter takes effect only when the ChargeType parameter is set to PrePaid. Valid values: true: enables auto-renewal. The renewal duration is the same as the subscription duration that you specified for the Period parameter when you purchased the cloud desktop. false: does not enable auto-renewal. Default value: false.

---

ChargeType^Optional

public object ChargeType { get; set; }

• Type: object

Property chargeType: The billing method of the cloud desktop.

Valid values: PostPaid: pay-as-you-go PrePaid: subscription Default value: PostPaid.

---

DesktopName^Optional

public object DesktopName { get; set; }

• Type: object

Property desktopName: The name of the cloud desktop.

---

DesktopNameSuffix^Optional

public object DesktopNameSuffix { get; set; }

• Type: object

Property desktopNameSuffix: Specifies whether to automatically add a suffix to the cloud desktop name when you create multiple cloud desktops at a time.

True: automatically adds a suffix. False: does not add a suffix.

---

DirectoryId^Optional

public object DirectoryId { get; set; }

• Type: object

Property directoryId: This parameter is not open for use.

---

EndUserId^Optional

public object EndUserId { get; set; }

• Type: object

Property endUserId: The user ID that authorizes the use of the cloud desktop, 1~100 can be set.

During the same period, only one user can use the desktop. If EndUserId is not set, the created cloud desktop will not be assigned to any user.

---

GroupId^Optional

public object GroupId { get; set; }

• Type: object

Property groupId: desktop group ID。 Note that the desktop group function is currently in the invitation test.

If you want to experience it, please submit a work order application.

---

Hostname^Optional

public object Hostname { get; set; }

• Type: object

Property hostname: The custom hostname that you specify for the cloud desktop.

You can only specify the hostname of a Windows cloud desktop in the workspace of the enterprise AD account type. The hostname must meet the following requirements: The hostname must be 2 to 15 characters in length. The hostname can contain letters, digits, and hyphens (-). It cannot start or end with a hyphen (-), contain consecutive hyphens (-), or contain only digits. If you create multiple cloud desktops, you can specify the names of the cloud desktops in the name_prefix[begin_number,bits]name_suffix format. For example, if you set Hostname to ecd--1,4-test, the hostname of the first cloud desktop is ecd-0001-test and the hostname of the second cloud desktop is ecd-0002-test. The rest may be deduced by analogy. name_prefix: the prefix of the hostname. [begin_number,bits]: the ordered numbers in the hostname. begin_number: the start number. Valid values: 0 to 999999. Default value: 0. bits: the digit. Valid values: 1 to 6. Default value: 6. name_suffix: the suffix of the hostname.

---

Period^Optional

public object Period { get; set; }

• Type: object

Property period: The subscription duration.

The unit of the value is specified by the PeriodUnit parameter. This parameter takes effect and is required only when the ChargeType parameter is set to PrePaid. If PeriodUnit is month, the valid range is 1, 2, 3, 6, 12, 24, 36, 48,60 If periodUnit is year, the valid range is 1 to 5

---

PeriodUnit^Optional

public object PeriodUnit { get; set; }

• Type: object

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

---

PromotionId^Optional

public object PromotionId { get; set; }

• Type: object

Property promotionId: promotion id.

---

Tags^Optional

public TagsProperty[] Tags { get; set; }

• Type: TagsProperty[]

Property tags: The list of desktops tags in the form of key\/value pairs.

You can define a maximum of 20 tags for each desktops.

---

UserAssignMode^Optional

public object UserAssignMode { get; set; }

• Type: object

Property userAssignMode: The assignment mode of the cloud desktop.

Default value: ALL. ALL: If you specify the EndUserId parameter, the cloud desktops that you create are assigned to each regular user that you specify. PER_USER: If you specify the EndUserId parameter, the cloud desktops that you create are evenly assigned to all regular users that you specify. In this case, you must make sure that the value of the Amount parameter can be divided by the N value of the EndUserId.N parameter that you specify. Note If you do not specify the EndUserId parameter, the cloud desktop that you create is not assigned to regular users.

---

UserName^Optional

public object UserName { get; set; }

• Type: object

Property userName: This parameter is not open for use.

---

VolumeEncryptionEnabled^Optional

public object VolumeEncryptionEnabled { get; set; }

• Type: object

Property volumeEncryptionEnabled: Whether to enable disk encryption.

---

VolumeEncryptionKey^Optional

public object VolumeEncryptionKey { get; set; }

• Type: object

Property volumeEncryptionKey: The key ID of the KMS used when disk encryption is enabled.

It can be obtained through the ListKeys interface.

---

VpcId^Optional

public object VpcId { get; set; }

• Type: object

Property vpcId: This parameter is not open for use.

---