index

title: "Desktop" title_tag: "huaweicloud.Workspace.Desktop" meta_desc: "Documentation for the huaweicloud.Workspace.Desktop resource with examples, input properties, output properties, lookup functions, and supporting types." layout: api no_edit_this_page: true

Manages a Workspace desktop resource within HuaweiCloud.

Create Desktop Resource {#create}

new Desktop(name: string, args: DesktopArgs, opts?: CustomResourceOptions);

@overload
def Desktop(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            availability_zone: Optional[str] = None,
            data_volumes: Optional[Sequence[_workspace.DesktopDataVolumeArgs]] = None,
            delete_user: Optional[bool] = None,
            email_notification: Optional[bool] = None,
            flavor_id: Optional[str] = None,
            image_id: Optional[str] = None,
            image_type: Optional[str] = None,
            name: Optional[str] = None,
            nics: Optional[Sequence[_workspace.DesktopNicArgs]] = None,
            region: Optional[str] = None,
            root_volume: Optional[_workspace.DesktopRootVolumeArgs] = None,
            security_groups: Optional[Sequence[str]] = None,
            tags: Optional[Mapping[str, str]] = None,
            user_email: Optional[str] = None,
            user_group: Optional[str] = None,
            user_name: Optional[str] = None,
            vpc_id: Optional[str] = None)
@overload
def Desktop(resource_name: str,
            args: DesktopArgs,
            opts: Optional[ResourceOptions] = None)

func NewDesktop(ctx *Context, name string, args DesktopArgs, opts ...ResourceOption) (*Desktop, error)

public Desktop(string name, DesktopArgs args, CustomResourceOptions? opts = null)

public Desktop(String name, DesktopArgs args)
public Desktop(String name, DesktopArgs args, CustomResourceOptions options)

type: huaweicloud:Workspace:Desktop
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DesktopArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DesktopArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DesktopArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DesktopArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DesktopArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Desktop Resource Properties {#properties}

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Desktop resource accepts the following input properties:

FlavorId string

Specifies the flavor ID of desktop.

ImageId string

Specifies the image ID to create the desktop. Changing this will create a new resource.

ImageType string

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

RootVolume DesktopRootVolumeArgs

Specifies the configuration of system volume. The object structure is documented below.

UserEmail string

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

UserGroup string

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

UserName string

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

VpcId string

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

AvailabilityZone string

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

DataVolumes List<DesktopDataVolumeArgs>

Specifies the configuration of data volumes. The object structure is documented below.

DeleteUser bool

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

EmailNotification bool

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

Name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

Nics List<DesktopNicArgs>

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

Region string

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

SecurityGroups List<string>

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

Tags Dictionary<string, string>

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

FlavorId string

Specifies the flavor ID of desktop.

ImageId string

Specifies the image ID to create the desktop. Changing this will create a new resource.

ImageType string

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

RootVolume DesktopRootVolumeArgs

Specifies the configuration of system volume. The object structure is documented below.

UserEmail string

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

UserGroup string

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

UserName string

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

VpcId string

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

AvailabilityZone string

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

DataVolumes []DesktopDataVolumeArgs

Specifies the configuration of data volumes. The object structure is documented below.

DeleteUser bool

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

EmailNotification bool

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

Name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

Nics []DesktopNicArgs

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

Region string

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

SecurityGroups []string

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

Tags map[string]string

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

flavorId String

Specifies the flavor ID of desktop.

imageId String

Specifies the image ID to create the desktop. Changing this will create a new resource.

imageType String

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

rootVolume DesktopRootVolumeArgs

Specifies the configuration of system volume. The object structure is documented below.

userEmail String

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

userGroup String

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

userName String

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

vpcId String

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

availabilityZone String

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

dataVolumes List<DesktopDataVolumeArgs>

Specifies the configuration of data volumes. The object structure is documented below.

deleteUser Boolean

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

emailNotification Boolean

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

name String

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

nics List<DesktopNicArgs>

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

region String

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

securityGroups List<String>

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

tags Map<String,String>

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

flavorId string

Specifies the flavor ID of desktop.

imageId string

Specifies the image ID to create the desktop. Changing this will create a new resource.

imageType string

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

rootVolume DesktopRootVolumeArgs

Specifies the configuration of system volume. The object structure is documented below.

userEmail string

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

userGroup string

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

userName string

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

vpcId string

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

availabilityZone string

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

dataVolumes DesktopDataVolumeArgs[]

Specifies the configuration of data volumes. The object structure is documented below.

deleteUser boolean

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

emailNotification boolean

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

nics DesktopNicArgs[]

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

region string

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

securityGroups string[]

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

tags {[key: string]: string}

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

flavor_id str

Specifies the flavor ID of desktop.

image_id str

Specifies the image ID to create the desktop. Changing this will create a new resource.

image_type str

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

root_volume DesktopRootVolumeArgs

Specifies the configuration of system volume. The object structure is documented below.

user_email str

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

user_group str

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

user_name str

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

vpc_id str

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

availability_zone str

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

data_volumes DesktopDataVolumeArgs]

Specifies the configuration of data volumes. The object structure is documented below.

delete_user bool

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

email_notification bool

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

name str

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

nics DesktopNicArgs]

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

region str

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

security_groups Sequence[str]

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

tags Mapping[str, str]

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

flavorId String

Specifies the flavor ID of desktop.

imageId String

Specifies the image ID to create the desktop. Changing this will create a new resource.

imageType String

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

rootVolume Property Map

Specifies the configuration of system volume. The object structure is documented below.

userEmail String

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

userGroup String

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

userName String

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

vpcId String

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

availabilityZone String

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

dataVolumes List<Property Map>

Specifies the configuration of data volumes. The object structure is documented below.

deleteUser Boolean

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

emailNotification Boolean

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

name String

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

nics List<Property Map>

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

region String

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

securityGroups List<String>

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

tags Map<String>

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Desktop resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Desktop Resource {#look-up}

Get an existing Desktop resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DesktopState, opts?: CustomResourceOptions): Desktop

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_zone: Optional[str] = None,
        data_volumes: Optional[Sequence[_workspace.DesktopDataVolumeArgs]] = None,
        delete_user: Optional[bool] = None,
        email_notification: Optional[bool] = None,
        flavor_id: Optional[str] = None,
        image_id: Optional[str] = None,
        image_type: Optional[str] = None,
        name: Optional[str] = None,
        nics: Optional[Sequence[_workspace.DesktopNicArgs]] = None,
        region: Optional[str] = None,
        root_volume: Optional[_workspace.DesktopRootVolumeArgs] = None,
        security_groups: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        user_email: Optional[str] = None,
        user_group: Optional[str] = None,
        user_name: Optional[str] = None,
        vpc_id: Optional[str] = None) -> Desktop

func GetDesktop(ctx *Context, name string, id IDInput, state *DesktopState, opts ...ResourceOption) (*Desktop, error)

public static Desktop Get(string name, Input<string> id, DesktopState? state, CustomResourceOptions? opts = null)

public static Desktop get(String name, Output<String> id, DesktopState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AvailabilityZone string

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

DataVolumes List<DesktopDataVolumeArgs>

Specifies the configuration of data volumes. The object structure is documented below.

DeleteUser bool

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

EmailNotification bool

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

FlavorId string

Specifies the flavor ID of desktop.

ImageId string

Specifies the image ID to create the desktop. Changing this will create a new resource.

ImageType string

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

Name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

Nics List<DesktopNicArgs>

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

Region string

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

RootVolume DesktopRootVolumeArgs

Specifies the configuration of system volume. The object structure is documented below.

SecurityGroups List<string>

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

Tags Dictionary<string, string>

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

UserEmail string

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

UserGroup string

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

UserName string

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

VpcId string

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

AvailabilityZone string

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

DataVolumes []DesktopDataVolumeArgs

Specifies the configuration of data volumes. The object structure is documented below.

DeleteUser bool

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

EmailNotification bool

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

FlavorId string

Specifies the flavor ID of desktop.

ImageId string

Specifies the image ID to create the desktop. Changing this will create a new resource.

ImageType string

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

Name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

Nics []DesktopNicArgs

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

Region string

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

RootVolume DesktopRootVolumeArgs

Specifies the configuration of system volume. The object structure is documented below.

SecurityGroups []string

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

Tags map[string]string

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

UserEmail string

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

UserGroup string

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

UserName string

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

VpcId string

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

availabilityZone String

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

dataVolumes List<DesktopDataVolumeArgs>

Specifies the configuration of data volumes. The object structure is documented below.

deleteUser Boolean

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

emailNotification Boolean

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

flavorId String

Specifies the flavor ID of desktop.

imageId String

Specifies the image ID to create the desktop. Changing this will create a new resource.

imageType String

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

name String

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

nics List<DesktopNicArgs>

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

region String

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

rootVolume DesktopRootVolumeArgs

Specifies the configuration of system volume. The object structure is documented below.

securityGroups List<String>

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

tags Map<String,String>

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

userEmail String

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

userGroup String

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

userName String

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

vpcId String

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

availabilityZone string

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

dataVolumes DesktopDataVolumeArgs[]

Specifies the configuration of data volumes. The object structure is documented below.

deleteUser boolean

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

emailNotification boolean

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

flavorId string

Specifies the flavor ID of desktop.

imageId string

Specifies the image ID to create the desktop. Changing this will create a new resource.

imageType string

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

nics DesktopNicArgs[]

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

region string

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

rootVolume DesktopRootVolumeArgs

Specifies the configuration of system volume. The object structure is documented below.

securityGroups string[]

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

tags {[key: string]: string}

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

userEmail string

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

userGroup string

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

userName string

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

vpcId string

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

availability_zone str

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

data_volumes DesktopDataVolumeArgs]

Specifies the configuration of data volumes. The object structure is documented below.

delete_user bool

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

email_notification bool

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

flavor_id str

Specifies the flavor ID of desktop.

image_id str

Specifies the image ID to create the desktop. Changing this will create a new resource.

image_type str

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

name str

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

nics DesktopNicArgs]

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

region str

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

root_volume DesktopRootVolumeArgs

Specifies the configuration of system volume. The object structure is documented below.

security_groups Sequence[str]

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

tags Mapping[str, str]

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

user_email str

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

user_group str

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

user_name str

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

vpc_id str

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

availabilityZone String

Specifies the availability zone where the desktop is located. Changing this will create a new resource.

dataVolumes List<Property Map>

Specifies the configuration of data volumes. The object structure is documented below.

deleteUser Boolean

Specifies whether to delete user associated with this desktop after deleting it. The user can only be successfully deleted if the user has no other desktops.

emailNotification Boolean

Specifies whether to send emails to user mailbox during important operations. Changing this will create a new resource.

flavorId String

Specifies the flavor ID of desktop.

imageId String

Specifies the image ID to create the desktop. Changing this will create a new resource.

imageType String

Specifies the image type. The valid values are as follows:

market: The market image.
gold: The public image.
private: The private image.

name String

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

nics List<Property Map>

Specifies the NIC information corresponding to the desktop. The object structure is documented below. Changing this will create a new resource.

region String

The region in which to create the Workspace desktop resource. If omitted, the provider-level region will be used. Changing this will create a new resource.

rootVolume Property Map

Specifies the configuration of system volume. The object structure is documented below.

securityGroups List<String>

Specifies the ID list of security groups. In addition to the custom security group, it must also contain a security group called WorkspaceUserSecurityGroup. Changing this will create a new resource.

tags Map<String>

Specifies the key/value pairs of the desktop. Changing this will create a new resource.

userEmail String

Specifies the user email. Some operations on the desktop (such as creation, deletion) will notify the user by sending an email. Changing this will create a new resource.

userGroup String

Specifies the user group to which the desktop belongs. The valid values are as follows:

sudo: Linux administrator group.
default: Linux default user group.
administrators: Windows administrator group.
users: Windows standard user group.

userName String

Specifies the user name to which the desktop belongs. The name can contain 1 to 20 characters, only letters, digits, hyphens (-) and underscores (_) are allowed. The name must start with a letter. Changing this will create a new resource.

vpcId String

Specifies the VPC ID to which the desktop belongs. Changing this will create a new resource.

Supporting Types

DesktopDataVolume

Size int

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

Type string

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

CreatedAt string

The time that the volume was created.

Device string

The device location to which the volume is attached.

Id string

The volume ID.

Name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

Size int

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

Type string

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

CreatedAt string

The time that the volume was created.

Device string

The device location to which the volume is attached.

Id string

The volume ID.

Name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

size Integer

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

type String

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

createdAt String

The time that the volume was created.

device String

The device location to which the volume is attached.

id String

The volume ID.

name String

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

size number

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

type string

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

createdAt string

The time that the volume was created.

device string

The device location to which the volume is attached.

id string

The volume ID.

name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

size int

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

type str

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

created_at str

The time that the volume was created.

device str

The device location to which the volume is attached.

id str

The volume ID.

name str

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

size Number

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

type String

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

createdAt String

The time that the volume was created.

device String

The device location to which the volume is attached.

id String

The volume ID.

name String

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

DesktopNic

NetworkId string: Specifies the network ID of subnet resource. Changing this will create a new resource.

NetworkId string: Specifies the network ID of subnet resource. Changing this will create a new resource.

networkId String: Specifies the network ID of subnet resource. Changing this will create a new resource.

networkId string: Specifies the network ID of subnet resource. Changing this will create a new resource.

network_id str: Specifies the network ID of subnet resource. Changing this will create a new resource.

networkId String: Specifies the network ID of subnet resource. Changing this will create a new resource.

DesktopRootVolume

Size int

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

Type string

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

CreatedAt string

The time that the volume was created.

Device string

The device location to which the volume is attached.

Id string

The volume ID.

Name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

Size int

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

Type string

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

CreatedAt string

The time that the volume was created.

Device string

The device location to which the volume is attached.

Id string

The volume ID.

Name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

size Integer

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

type String

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

createdAt String

The time that the volume was created.

device String

The device location to which the volume is attached.

id String

The volume ID.

name String

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

size number

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

type string

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

createdAt string

The time that the volume was created.

device string

The device location to which the volume is attached.

id string

The volume ID.

name string

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

size int

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

type str

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

created_at str

The time that the volume was created.

device str

The device location to which the volume is attached.

id str

The volume ID.

name str

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

size Number

Specifies the size of system volume, in GB.

For root volume, the valid value is range from 80 to 1,020.
For data volume, the valid value is range from 10 to 8,200.

type String

Specifies the type of system volume. The valid values are as follows:

SAS: High I/O disk type.
SSD: Ultra-high I/O disk type.

createdAt String

The time that the volume was created.

device String

The device location to which the volume is attached.

id String

The volume ID.

name String

Specifies the desktop name. The name can contain 1 to 15 characters, only letters, digits and hyphens (-) are allowed. The name must start with a letter or digit and cannot end with a hyphen. Changing this will create a new resource.

Import

Desktops can be imported using the id, e.g.

 $ pulumi import huaweicloud:Workspace/desktop:Desktop test 339d2539-e945-4090-a08d-c16badc0c6bb

Note that the imported state may not be identical to your resource definition, due to some attributes missing from the API response. The missing attributes includenic and user_email. It is generally recommended running terraform plan after importing a desktop. You can then decide if changes should be applied to the desktop, or the resource definition should be updated to align with the desktop. Also you can ignore changes as below. resource "huaweicloud_workspace_desktop" "test" {

...

lifecycle {

ignore_changes = [

user_email, nic,

]

} }

Package Details

Repository: https://github.com/huaweicloud/pulumi-huaweicloud
License: Apache-2.0
Notes: This Pulumi package is based on the huaweicloud Terraform Provider.