1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. eds
  5. Desktop
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

alicloud.eds.Desktop

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

    Provides a ECD Desktop resource.

    For information about ECD Desktop and how to use it, see What is Desktop

    NOTE: Available since v1.144.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    import * as random from "@pulumi/random";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "terraform-example";
    const defaultInteger = new random.index.Integer("default", {
        min: 10000,
        max: 99999,
    });
    const defaultSimpleOfficeSite = new alicloud.eds.SimpleOfficeSite("default", {
        cidrBlock: "172.16.0.0/12",
        enableAdminAccess: true,
        desktopAccessType: "Internet",
        officeSiteName: `${name}-${defaultInteger.result}`,
    });
    const defaultEcdPolicyGroup = new alicloud.eds.EcdPolicyGroup("default", {
        policyGroupName: name,
        clipboard: "read",
        localDrive: "read",
        usbRedirect: "off",
        watermark: "off",
        authorizeAccessPolicyRules: [{
            description: name,
            cidrIp: "1.2.3.45/24",
        }],
        authorizeSecurityPolicyRules: [{
            type: "inflow",
            policy: "accept",
            description: name,
            portRange: "80/80",
            ipProtocol: "TCP",
            priority: "1",
            cidrIp: "1.2.3.4/24",
        }],
    });
    const default = alicloud.eds.getBundles({
        bundleType: "SYSTEM",
    });
    const defaultDesktop = new alicloud.eds.Desktop("default", {
        officeSiteId: defaultSimpleOfficeSite.id,
        policyGroupId: defaultEcdPolicyGroup.id,
        bundleId: _default.then(_default => _default.bundles?.[1]?.id),
        desktopName: name,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    import pulumi_random as random
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    default_integer = random.index.Integer("default",
        min=10000,
        max=99999)
    default_simple_office_site = alicloud.eds.SimpleOfficeSite("default",
        cidr_block="172.16.0.0/12",
        enable_admin_access=True,
        desktop_access_type="Internet",
        office_site_name=f"{name}-{default_integer['result']}")
    default_ecd_policy_group = alicloud.eds.EcdPolicyGroup("default",
        policy_group_name=name,
        clipboard="read",
        local_drive="read",
        usb_redirect="off",
        watermark="off",
        authorize_access_policy_rules=[{
            "description": name,
            "cidr_ip": "1.2.3.45/24",
        }],
        authorize_security_policy_rules=[{
            "type": "inflow",
            "policy": "accept",
            "description": name,
            "port_range": "80/80",
            "ip_protocol": "TCP",
            "priority": "1",
            "cidr_ip": "1.2.3.4/24",
        }])
    default = alicloud.eds.get_bundles(bundle_type="SYSTEM")
    default_desktop = alicloud.eds.Desktop("default",
        office_site_id=default_simple_office_site.id,
        policy_group_id=default_ecd_policy_group.id,
        bundle_id=default.bundles[1].id,
        desktop_name=name)
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/eds"
    	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		name := "terraform-example"
    		if param := cfg.Get("name"); param != "" {
    			name = param
    		}
    		defaultInteger, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
    			Min: 10000,
    			Max: 99999,
    		})
    		if err != nil {
    			return err
    		}
    		defaultSimpleOfficeSite, err := eds.NewSimpleOfficeSite(ctx, "default", &eds.SimpleOfficeSiteArgs{
    			CidrBlock:         pulumi.String("172.16.0.0/12"),
    			EnableAdminAccess: pulumi.Bool(true),
    			DesktopAccessType: pulumi.String("Internet"),
    			OfficeSiteName:    pulumi.Sprintf("%v-%v", name, defaultInteger.Result),
    		})
    		if err != nil {
    			return err
    		}
    		defaultEcdPolicyGroup, err := eds.NewEcdPolicyGroup(ctx, "default", &eds.EcdPolicyGroupArgs{
    			PolicyGroupName: pulumi.String(name),
    			Clipboard:       pulumi.String("read"),
    			LocalDrive:      pulumi.String("read"),
    			UsbRedirect:     pulumi.String("off"),
    			Watermark:       pulumi.String("off"),
    			AuthorizeAccessPolicyRules: eds.EcdPolicyGroupAuthorizeAccessPolicyRuleArray{
    				&eds.EcdPolicyGroupAuthorizeAccessPolicyRuleArgs{
    					Description: pulumi.String(name),
    					CidrIp:      pulumi.String("1.2.3.45/24"),
    				},
    			},
    			AuthorizeSecurityPolicyRules: eds.EcdPolicyGroupAuthorizeSecurityPolicyRuleArray{
    				&eds.EcdPolicyGroupAuthorizeSecurityPolicyRuleArgs{
    					Type:        pulumi.String("inflow"),
    					Policy:      pulumi.String("accept"),
    					Description: pulumi.String(name),
    					PortRange:   pulumi.String("80/80"),
    					IpProtocol:  pulumi.String("TCP"),
    					Priority:    pulumi.String("1"),
    					CidrIp:      pulumi.String("1.2.3.4/24"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_default, err := eds.GetBundles(ctx, &eds.GetBundlesArgs{
    			BundleType: pulumi.StringRef("SYSTEM"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = eds.NewDesktop(ctx, "default", &eds.DesktopArgs{
    			OfficeSiteId:  defaultSimpleOfficeSite.ID(),
    			PolicyGroupId: defaultEcdPolicyGroup.ID(),
    			BundleId:      pulumi.String(_default.Bundles[1].Id),
    			DesktopName:   pulumi.String(name),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    using Random = Pulumi.Random;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var name = config.Get("name") ?? "terraform-example";
        var defaultInteger = new Random.Index.Integer("default", new()
        {
            Min = 10000,
            Max = 99999,
        });
    
        var defaultSimpleOfficeSite = new AliCloud.Eds.SimpleOfficeSite("default", new()
        {
            CidrBlock = "172.16.0.0/12",
            EnableAdminAccess = true,
            DesktopAccessType = "Internet",
            OfficeSiteName = $"{name}-{defaultInteger.Result}",
        });
    
        var defaultEcdPolicyGroup = new AliCloud.Eds.EcdPolicyGroup("default", new()
        {
            PolicyGroupName = name,
            Clipboard = "read",
            LocalDrive = "read",
            UsbRedirect = "off",
            Watermark = "off",
            AuthorizeAccessPolicyRules = new[]
            {
                new AliCloud.Eds.Inputs.EcdPolicyGroupAuthorizeAccessPolicyRuleArgs
                {
                    Description = name,
                    CidrIp = "1.2.3.45/24",
                },
            },
            AuthorizeSecurityPolicyRules = new[]
            {
                new AliCloud.Eds.Inputs.EcdPolicyGroupAuthorizeSecurityPolicyRuleArgs
                {
                    Type = "inflow",
                    Policy = "accept",
                    Description = name,
                    PortRange = "80/80",
                    IpProtocol = "TCP",
                    Priority = "1",
                    CidrIp = "1.2.3.4/24",
                },
            },
        });
    
        var @default = AliCloud.Eds.GetBundles.Invoke(new()
        {
            BundleType = "SYSTEM",
        });
    
        var defaultDesktop = new AliCloud.Eds.Desktop("default", new()
        {
            OfficeSiteId = defaultSimpleOfficeSite.Id,
            PolicyGroupId = defaultEcdPolicyGroup.Id,
            BundleId = @default.Apply(@default => @default.Apply(getBundlesResult => getBundlesResult.Bundles[1]?.Id)),
            DesktopName = name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.random.integer;
    import com.pulumi.random.IntegerArgs;
    import com.pulumi.alicloud.eds.SimpleOfficeSite;
    import com.pulumi.alicloud.eds.SimpleOfficeSiteArgs;
    import com.pulumi.alicloud.eds.EcdPolicyGroup;
    import com.pulumi.alicloud.eds.EcdPolicyGroupArgs;
    import com.pulumi.alicloud.eds.inputs.EcdPolicyGroupAuthorizeAccessPolicyRuleArgs;
    import com.pulumi.alicloud.eds.inputs.EcdPolicyGroupAuthorizeSecurityPolicyRuleArgs;
    import com.pulumi.alicloud.eds.EdsFunctions;
    import com.pulumi.alicloud.eds.inputs.GetBundlesArgs;
    import com.pulumi.alicloud.eds.Desktop;
    import com.pulumi.alicloud.eds.DesktopArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var config = ctx.config();
            final var name = config.get("name").orElse("terraform-example");
            var defaultInteger = new Integer("defaultInteger", IntegerArgs.builder()
                .min(10000)
                .max(99999)
                .build());
    
            var defaultSimpleOfficeSite = new SimpleOfficeSite("defaultSimpleOfficeSite", SimpleOfficeSiteArgs.builder()
                .cidrBlock("172.16.0.0/12")
                .enableAdminAccess(true)
                .desktopAccessType("Internet")
                .officeSiteName(String.format("%s-%s", name,defaultInteger.result()))
                .build());
    
            var defaultEcdPolicyGroup = new EcdPolicyGroup("defaultEcdPolicyGroup", EcdPolicyGroupArgs.builder()
                .policyGroupName(name)
                .clipboard("read")
                .localDrive("read")
                .usbRedirect("off")
                .watermark("off")
                .authorizeAccessPolicyRules(EcdPolicyGroupAuthorizeAccessPolicyRuleArgs.builder()
                    .description(name)
                    .cidrIp("1.2.3.45/24")
                    .build())
                .authorizeSecurityPolicyRules(EcdPolicyGroupAuthorizeSecurityPolicyRuleArgs.builder()
                    .type("inflow")
                    .policy("accept")
                    .description(name)
                    .portRange("80/80")
                    .ipProtocol("TCP")
                    .priority("1")
                    .cidrIp("1.2.3.4/24")
                    .build())
                .build());
    
            final var default = EdsFunctions.getBundles(GetBundlesArgs.builder()
                .bundleType("SYSTEM")
                .build());
    
            var defaultDesktop = new Desktop("defaultDesktop", DesktopArgs.builder()
                .officeSiteId(defaultSimpleOfficeSite.id())
                .policyGroupId(defaultEcdPolicyGroup.id())
                .bundleId(default_.bundles()[1].id())
                .desktopName(name)
                .build());
    
        }
    }
    
    configuration:
      name:
        type: string
        default: terraform-example
    resources:
      defaultInteger:
        type: random:integer
        name: default
        properties:
          min: 10000
          max: 99999
      defaultSimpleOfficeSite:
        type: alicloud:eds:SimpleOfficeSite
        name: default
        properties:
          cidrBlock: 172.16.0.0/12
          enableAdminAccess: true
          desktopAccessType: Internet
          officeSiteName: ${name}-${defaultInteger.result}
      defaultEcdPolicyGroup:
        type: alicloud:eds:EcdPolicyGroup
        name: default
        properties:
          policyGroupName: ${name}
          clipboard: read
          localDrive: read
          usbRedirect: off
          watermark: off
          authorizeAccessPolicyRules:
            - description: ${name}
              cidrIp: 1.2.3.45/24
          authorizeSecurityPolicyRules:
            - type: inflow
              policy: accept
              description: ${name}
              portRange: 80/80
              ipProtocol: TCP
              priority: '1'
              cidrIp: 1.2.3.4/24
      defaultDesktop:
        type: alicloud:eds:Desktop
        name: default
        properties:
          officeSiteId: ${defaultSimpleOfficeSite.id}
          policyGroupId: ${defaultEcdPolicyGroup.id}
          bundleId: ${default.bundles[1].id}
          desktopName: ${name}
    variables:
      default:
        fn::invoke:
          Function: alicloud:eds:getBundles
          Arguments:
            bundleType: SYSTEM
    

    Create Desktop Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Desktop(name: string, args: DesktopArgs, opts?: CustomResourceOptions);
    @overload
    def Desktop(resource_name: str,
                args: DesktopArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Desktop(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                policy_group_id: Optional[str] = None,
                bundle_id: Optional[str] = None,
                office_site_id: Optional[str] = None,
                user_disk_size_gib: Optional[int] = None,
                desktop_name: Optional[str] = None,
                desktop_type: Optional[str] = None,
                end_user_ids: Optional[Sequence[str]] = None,
                host_name: Optional[str] = None,
                auto_renew: Optional[bool] = None,
                auto_pay: Optional[bool] = None,
                period_unit: Optional[str] = None,
                period: Optional[int] = None,
                amount: Optional[int] = None,
                root_disk_size_gib: Optional[int] = None,
                status: Optional[str] = None,
                stopped_mode: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                user_assign_mode: Optional[str] = None,
                payment_type: Optional[str] = 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: alicloud:eds:Desktop
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var desktopResource = new AliCloud.Eds.Desktop("desktopResource", new()
    {
        PolicyGroupId = "string",
        BundleId = "string",
        OfficeSiteId = "string",
        UserDiskSizeGib = 0,
        DesktopName = "string",
        DesktopType = "string",
        EndUserIds = new[]
        {
            "string",
        },
        HostName = "string",
        AutoRenew = false,
        AutoPay = false,
        PeriodUnit = "string",
        Period = 0,
        Amount = 0,
        RootDiskSizeGib = 0,
        Status = "string",
        StoppedMode = "string",
        Tags = 
        {
            { "string", "string" },
        },
        UserAssignMode = "string",
        PaymentType = "string",
    });
    
    example, err := eds.NewDesktop(ctx, "desktopResource", &eds.DesktopArgs{
    	PolicyGroupId:   pulumi.String("string"),
    	BundleId:        pulumi.String("string"),
    	OfficeSiteId:    pulumi.String("string"),
    	UserDiskSizeGib: pulumi.Int(0),
    	DesktopName:     pulumi.String("string"),
    	DesktopType:     pulumi.String("string"),
    	EndUserIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	HostName:        pulumi.String("string"),
    	AutoRenew:       pulumi.Bool(false),
    	AutoPay:         pulumi.Bool(false),
    	PeriodUnit:      pulumi.String("string"),
    	Period:          pulumi.Int(0),
    	Amount:          pulumi.Int(0),
    	RootDiskSizeGib: pulumi.Int(0),
    	Status:          pulumi.String("string"),
    	StoppedMode:     pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	UserAssignMode: pulumi.String("string"),
    	PaymentType:    pulumi.String("string"),
    })
    
    var desktopResource = new Desktop("desktopResource", DesktopArgs.builder()
        .policyGroupId("string")
        .bundleId("string")
        .officeSiteId("string")
        .userDiskSizeGib(0)
        .desktopName("string")
        .desktopType("string")
        .endUserIds("string")
        .hostName("string")
        .autoRenew(false)
        .autoPay(false)
        .periodUnit("string")
        .period(0)
        .amount(0)
        .rootDiskSizeGib(0)
        .status("string")
        .stoppedMode("string")
        .tags(Map.of("string", "string"))
        .userAssignMode("string")
        .paymentType("string")
        .build());
    
    desktop_resource = alicloud.eds.Desktop("desktopResource",
        policy_group_id="string",
        bundle_id="string",
        office_site_id="string",
        user_disk_size_gib=0,
        desktop_name="string",
        desktop_type="string",
        end_user_ids=["string"],
        host_name="string",
        auto_renew=False,
        auto_pay=False,
        period_unit="string",
        period=0,
        amount=0,
        root_disk_size_gib=0,
        status="string",
        stopped_mode="string",
        tags={
            "string": "string",
        },
        user_assign_mode="string",
        payment_type="string")
    
    const desktopResource = new alicloud.eds.Desktop("desktopResource", {
        policyGroupId: "string",
        bundleId: "string",
        officeSiteId: "string",
        userDiskSizeGib: 0,
        desktopName: "string",
        desktopType: "string",
        endUserIds: ["string"],
        hostName: "string",
        autoRenew: false,
        autoPay: false,
        periodUnit: "string",
        period: 0,
        amount: 0,
        rootDiskSizeGib: 0,
        status: "string",
        stoppedMode: "string",
        tags: {
            string: "string",
        },
        userAssignMode: "string",
        paymentType: "string",
    });
    
    type: alicloud:eds:Desktop
    properties:
        amount: 0
        autoPay: false
        autoRenew: false
        bundleId: string
        desktopName: string
        desktopType: string
        endUserIds:
            - string
        hostName: string
        officeSiteId: string
        paymentType: string
        period: 0
        periodUnit: string
        policyGroupId: string
        rootDiskSizeGib: 0
        status: string
        stoppedMode: string
        tags:
            string: string
        userAssignMode: string
        userDiskSizeGib: 0
    

    Desktop Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Desktop resource accepts the following input properties:

    BundleId string
    The bundle id of the Desktop.
    OfficeSiteId string
    The ID of the Simple Office Site.
    PolicyGroupId string
    The policy group id of the Desktop.
    Amount int
    The amount of the Desktop.
    AutoPay bool
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    AutoRenew bool
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    DesktopName string
    The desktop name of the Desktop.
    DesktopType string
    The desktop type of the Desktop.
    EndUserIds List<string>
    The desktop end user id of the Desktop.
    HostName string
    The hostname of the Desktop.
    PaymentType string
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    Period int
    The period of the Desktop.
    PeriodUnit string
    The period unit of the Desktop.
    RootDiskSizeGib int
    The root disk size gib of the Desktop.
    Status string
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    StoppedMode string
    The stopped mode of the Desktop.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    UserAssignMode string
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    UserDiskSizeGib int
    The user disk size gib of the Desktop.
    BundleId string
    The bundle id of the Desktop.
    OfficeSiteId string
    The ID of the Simple Office Site.
    PolicyGroupId string
    The policy group id of the Desktop.
    Amount int
    The amount of the Desktop.
    AutoPay bool
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    AutoRenew bool
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    DesktopName string
    The desktop name of the Desktop.
    DesktopType string
    The desktop type of the Desktop.
    EndUserIds []string
    The desktop end user id of the Desktop.
    HostName string
    The hostname of the Desktop.
    PaymentType string
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    Period int
    The period of the Desktop.
    PeriodUnit string
    The period unit of the Desktop.
    RootDiskSizeGib int
    The root disk size gib of the Desktop.
    Status string
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    StoppedMode string
    The stopped mode of the Desktop.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    UserAssignMode string
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    UserDiskSizeGib int
    The user disk size gib of the Desktop.
    bundleId String
    The bundle id of the Desktop.
    officeSiteId String
    The ID of the Simple Office Site.
    policyGroupId String
    The policy group id of the Desktop.
    amount Integer
    The amount of the Desktop.
    autoPay Boolean
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    autoRenew Boolean
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    desktopName String
    The desktop name of the Desktop.
    desktopType String
    The desktop type of the Desktop.
    endUserIds List<String>
    The desktop end user id of the Desktop.
    hostName String
    The hostname of the Desktop.
    paymentType String
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    period Integer
    The period of the Desktop.
    periodUnit String
    The period unit of the Desktop.
    rootDiskSizeGib Integer
    The root disk size gib of the Desktop.
    status String
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    stoppedMode String
    The stopped mode of the Desktop.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    userAssignMode String
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    userDiskSizeGib Integer
    The user disk size gib of the Desktop.
    bundleId string
    The bundle id of the Desktop.
    officeSiteId string
    The ID of the Simple Office Site.
    policyGroupId string
    The policy group id of the Desktop.
    amount number
    The amount of the Desktop.
    autoPay boolean
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    autoRenew boolean
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    desktopName string
    The desktop name of the Desktop.
    desktopType string
    The desktop type of the Desktop.
    endUserIds string[]
    The desktop end user id of the Desktop.
    hostName string
    The hostname of the Desktop.
    paymentType string
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    period number
    The period of the Desktop.
    periodUnit string
    The period unit of the Desktop.
    rootDiskSizeGib number
    The root disk size gib of the Desktop.
    status string
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    stoppedMode string
    The stopped mode of the Desktop.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    userAssignMode string
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    userDiskSizeGib number
    The user disk size gib of the Desktop.
    bundle_id str
    The bundle id of the Desktop.
    office_site_id str
    The ID of the Simple Office Site.
    policy_group_id str
    The policy group id of the Desktop.
    amount int
    The amount of the Desktop.
    auto_pay bool
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    auto_renew bool
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    desktop_name str
    The desktop name of the Desktop.
    desktop_type str
    The desktop type of the Desktop.
    end_user_ids Sequence[str]
    The desktop end user id of the Desktop.
    host_name str
    The hostname of the Desktop.
    payment_type str
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    period int
    The period of the Desktop.
    period_unit str
    The period unit of the Desktop.
    root_disk_size_gib int
    The root disk size gib of the Desktop.
    status str
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    stopped_mode str
    The stopped mode of the Desktop.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    user_assign_mode str
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    user_disk_size_gib int
    The user disk size gib of the Desktop.
    bundleId String
    The bundle id of the Desktop.
    officeSiteId String
    The ID of the Simple Office Site.
    policyGroupId String
    The policy group id of the Desktop.
    amount Number
    The amount of the Desktop.
    autoPay Boolean
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    autoRenew Boolean
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    desktopName String
    The desktop name of the Desktop.
    desktopType String
    The desktop type of the Desktop.
    endUserIds List<String>
    The desktop end user id of the Desktop.
    hostName String
    The hostname of the Desktop.
    paymentType String
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    period Number
    The period of the Desktop.
    periodUnit String
    The period unit of the Desktop.
    rootDiskSizeGib Number
    The root disk size gib of the Desktop.
    status String
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    stoppedMode String
    The stopped mode of the Desktop.
    tags Map<String>
    A mapping of tags to assign to the resource.
    userAssignMode String
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    userDiskSizeGib Number
    The user disk size gib of the Desktop.

    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

    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,
            amount: Optional[int] = None,
            auto_pay: Optional[bool] = None,
            auto_renew: Optional[bool] = None,
            bundle_id: Optional[str] = None,
            desktop_name: Optional[str] = None,
            desktop_type: Optional[str] = None,
            end_user_ids: Optional[Sequence[str]] = None,
            host_name: Optional[str] = None,
            office_site_id: Optional[str] = None,
            payment_type: Optional[str] = None,
            period: Optional[int] = None,
            period_unit: Optional[str] = None,
            policy_group_id: Optional[str] = None,
            root_disk_size_gib: Optional[int] = None,
            status: Optional[str] = None,
            stopped_mode: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            user_assign_mode: Optional[str] = None,
            user_disk_size_gib: Optional[int] = 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:
    Amount int
    The amount of the Desktop.
    AutoPay bool
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    AutoRenew bool
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    BundleId string
    The bundle id of the Desktop.
    DesktopName string
    The desktop name of the Desktop.
    DesktopType string
    The desktop type of the Desktop.
    EndUserIds List<string>
    The desktop end user id of the Desktop.
    HostName string
    The hostname of the Desktop.
    OfficeSiteId string
    The ID of the Simple Office Site.
    PaymentType string
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    Period int
    The period of the Desktop.
    PeriodUnit string
    The period unit of the Desktop.
    PolicyGroupId string
    The policy group id of the Desktop.
    RootDiskSizeGib int
    The root disk size gib of the Desktop.
    Status string
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    StoppedMode string
    The stopped mode of the Desktop.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    UserAssignMode string
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    UserDiskSizeGib int
    The user disk size gib of the Desktop.
    Amount int
    The amount of the Desktop.
    AutoPay bool
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    AutoRenew bool
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    BundleId string
    The bundle id of the Desktop.
    DesktopName string
    The desktop name of the Desktop.
    DesktopType string
    The desktop type of the Desktop.
    EndUserIds []string
    The desktop end user id of the Desktop.
    HostName string
    The hostname of the Desktop.
    OfficeSiteId string
    The ID of the Simple Office Site.
    PaymentType string
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    Period int
    The period of the Desktop.
    PeriodUnit string
    The period unit of the Desktop.
    PolicyGroupId string
    The policy group id of the Desktop.
    RootDiskSizeGib int
    The root disk size gib of the Desktop.
    Status string
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    StoppedMode string
    The stopped mode of the Desktop.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    UserAssignMode string
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    UserDiskSizeGib int
    The user disk size gib of the Desktop.
    amount Integer
    The amount of the Desktop.
    autoPay Boolean
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    autoRenew Boolean
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    bundleId String
    The bundle id of the Desktop.
    desktopName String
    The desktop name of the Desktop.
    desktopType String
    The desktop type of the Desktop.
    endUserIds List<String>
    The desktop end user id of the Desktop.
    hostName String
    The hostname of the Desktop.
    officeSiteId String
    The ID of the Simple Office Site.
    paymentType String
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    period Integer
    The period of the Desktop.
    periodUnit String
    The period unit of the Desktop.
    policyGroupId String
    The policy group id of the Desktop.
    rootDiskSizeGib Integer
    The root disk size gib of the Desktop.
    status String
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    stoppedMode String
    The stopped mode of the Desktop.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    userAssignMode String
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    userDiskSizeGib Integer
    The user disk size gib of the Desktop.
    amount number
    The amount of the Desktop.
    autoPay boolean
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    autoRenew boolean
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    bundleId string
    The bundle id of the Desktop.
    desktopName string
    The desktop name of the Desktop.
    desktopType string
    The desktop type of the Desktop.
    endUserIds string[]
    The desktop end user id of the Desktop.
    hostName string
    The hostname of the Desktop.
    officeSiteId string
    The ID of the Simple Office Site.
    paymentType string
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    period number
    The period of the Desktop.
    periodUnit string
    The period unit of the Desktop.
    policyGroupId string
    The policy group id of the Desktop.
    rootDiskSizeGib number
    The root disk size gib of the Desktop.
    status string
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    stoppedMode string
    The stopped mode of the Desktop.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    userAssignMode string
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    userDiskSizeGib number
    The user disk size gib of the Desktop.
    amount int
    The amount of the Desktop.
    auto_pay bool
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    auto_renew bool
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    bundle_id str
    The bundle id of the Desktop.
    desktop_name str
    The desktop name of the Desktop.
    desktop_type str
    The desktop type of the Desktop.
    end_user_ids Sequence[str]
    The desktop end user id of the Desktop.
    host_name str
    The hostname of the Desktop.
    office_site_id str
    The ID of the Simple Office Site.
    payment_type str
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    period int
    The period of the Desktop.
    period_unit str
    The period unit of the Desktop.
    policy_group_id str
    The policy group id of the Desktop.
    root_disk_size_gib int
    The root disk size gib of the Desktop.
    status str
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    stopped_mode str
    The stopped mode of the Desktop.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    user_assign_mode str
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    user_disk_size_gib int
    The user disk size gib of the Desktop.
    amount Number
    The amount of the Desktop.
    autoPay Boolean
    The auto-pay of the Desktop whether to pay automatically. values: true, false.
    autoRenew Boolean
    The auto-renewal of the Desktop whether to renew automatically. It takes effect only when the parameter ChargeType is set to PrePaid. values: true, false.
    bundleId String
    The bundle id of the Desktop.
    desktopName String
    The desktop name of the Desktop.
    desktopType String
    The desktop type of the Desktop.
    endUserIds List<String>
    The desktop end user id of the Desktop.
    hostName String
    The hostname of the Desktop.
    officeSiteId String
    The ID of the Simple Office Site.
    paymentType String
    The payment type of the Desktop. Valid values: PayAsYouGo, Subscription. Default to PayAsYouGo.
    period Number
    The period of the Desktop.
    periodUnit String
    The period unit of the Desktop.
    policyGroupId String
    The policy group id of the Desktop.
    rootDiskSizeGib Number
    The root disk size gib of the Desktop.
    status String
    The status of the Desktop. Valid values: Deleted, Expired, Pending, Running, Starting, Stopped, Stopping.
    stoppedMode String
    The stopped mode of the Desktop.
    tags Map<String>
    A mapping of tags to assign to the resource.
    userAssignMode String
    The user assign mode of the Desktop. Valid values: ALL, PER_USER. Default to ALL.
    userDiskSizeGib Number
    The user disk size gib of the Desktop.

    Import

    ECD Desktop can be imported using the id, e.g.

    $ pulumi import alicloud:eds/desktop:Desktop example <id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi