1. Registry
  2. Packages
  3. Alibaba Cloud Provider
  4. API Docs
  5. ecddesktop
  6. getGroups
Viewing docs for Alibaba Cloud v3.108.0
published on Thursday, Sep 17, 2026 by Pulumi
alicloud logo alicloud logo
Viewing docs for Alibaba Cloud v3.108.0
published on Thursday, Sep 17, 2026 by Pulumi

    This data source provides Elastic Desktop Service (ECD) Desktop Groups available to the user. For information about Elastic Desktop Service (ECD) Desktop Group, see What is Desktop Group.

    NOTE: Available since v1.291.0.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "terraform-example";
    const _default = alicloud.eds.getBundles({
        bundleType: "SYSTEM",
    });
    const defaultSimpleOfficeSite = new alicloud.eds.SimpleOfficeSite("default", {
        cidrBlock: "172.16.0.0/12",
        desktopAccessType: "Internet",
        officeSiteName: name,
    });
    const defaultEcdPolicyGroup = new alicloud.eds.EcdPolicyGroup("default", {
        policyGroupName: name,
        clipboard: "readwrite",
        localDrive: "read",
        authorizeAccessPolicyRules: [{
            description: name,
            cidrIp: "1.2.3.4/24",
        }],
        authorizeSecurityPolicyRules: [{
            type: "inflow",
            policy: "accept",
            description: name,
            portRange: "80/80",
            ipProtocol: "TCP",
            priority: "1",
            cidrIp: "0.0.0.0/0",
        }],
    });
    const defaultUser = new alicloud.eds.User("default", {
        endUserId: "terraform-example-user",
        email: "terraform-example@example.com",
        password: "Example12345",
    });
    const defaultGroup = new alicloud.ecddesktop.Group("default", {
        desktopGroupName: name,
        officeSiteId: defaultSimpleOfficeSite.id,
        policyGroupId: defaultEcdPolicyGroup.id,
        bundleId: _default.then(_default => _default.bundles?.[0]?.id),
        endUserIds: [defaultUser.id],
        allowBufferCount: 1,
    });
    const defaultGetGroups = alicloud.ecddesktop.getGroupsOutput({
        ids: [defaultGroup.id],
        nameRegex: defaultGroup.desktopGroupName,
    });
    export const alicloudEcdDesktopGroupExampleId = defaultGetGroups.apply(defaultGetGroups => defaultGetGroups.groups?.[0]?.id);
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    default = alicloud.eds.get_bundles(bundle_type="SYSTEM")
    default_simple_office_site = alicloud.eds.SimpleOfficeSite("default",
        cidr_block="172.16.0.0/12",
        desktop_access_type="Internet",
        office_site_name=name)
    default_ecd_policy_group = alicloud.eds.EcdPolicyGroup("default",
        policy_group_name=name,
        clipboard="readwrite",
        local_drive="read",
        authorize_access_policy_rules=[{
            "description": name,
            "cidr_ip": "1.2.3.4/24",
        }],
        authorize_security_policy_rules=[{
            "type": "inflow",
            "policy": "accept",
            "description": name,
            "port_range": "80/80",
            "ip_protocol": "TCP",
            "priority": "1",
            "cidr_ip": "0.0.0.0/0",
        }])
    default_user = alicloud.eds.User("default",
        end_user_id="terraform-example-user",
        email="terraform-example@example.com",
        password="Example12345")
    default_group = alicloud.ecddesktop.Group("default",
        desktop_group_name=name,
        office_site_id=default_simple_office_site.id,
        policy_group_id=default_ecd_policy_group.id,
        bundle_id=default.bundles[0].id,
        end_user_ids=[default_user.id],
        allow_buffer_count=1)
    default_get_groups = alicloud.ecddesktop.get_groups_output(ids=[default_group.id],
        name_regex=default_group.desktop_group_name)
    pulumi.export("alicloudEcdDesktopGroupExampleId", default_get_groups.groups[0].id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecddesktop"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/eds"
    	"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
    		}
    		_default, err := eds.GetBundles(ctx, &eds.GetBundlesArgs{
    			BundleType: pulumi.StringRef("SYSTEM"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		defaultSimpleOfficeSite, err := eds.NewSimpleOfficeSite(ctx, "default", &eds.SimpleOfficeSiteArgs{
    			CidrBlock:         pulumi.String("172.16.0.0/12"),
    			DesktopAccessType: pulumi.String("Internet"),
    			OfficeSiteName:    pulumi.String(name),
    		})
    		if err != nil {
    			return err
    		}
    		defaultEcdPolicyGroup, err := eds.NewEcdPolicyGroup(ctx, "default", &eds.EcdPolicyGroupArgs{
    			PolicyGroupName: pulumi.String(name),
    			Clipboard:       pulumi.String("readwrite"),
    			LocalDrive:      pulumi.String("read"),
    			AuthorizeAccessPolicyRules: eds.EcdPolicyGroupAuthorizeAccessPolicyRuleArray{
    				&eds.EcdPolicyGroupAuthorizeAccessPolicyRuleArgs{
    					Description: pulumi.String(name),
    					CidrIp:      pulumi.String("1.2.3.4/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("0.0.0.0/0"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		defaultUser, err := eds.NewUser(ctx, "default", &eds.UserArgs{
    			EndUserId: pulumi.String("terraform-example-user"),
    			Email:     pulumi.String("terraform-example@example.com"),
    			Password:  pulumi.String("Example12345"),
    		})
    		if err != nil {
    			return err
    		}
    		defaultGroup, err := ecddesktop.NewGroup(ctx, "default", &ecddesktop.GroupArgs{
    			DesktopGroupName: pulumi.String(name),
    			OfficeSiteId:     defaultSimpleOfficeSite.ID().ToIDOutput().ToStringOutput(),
    			PolicyGroupId:    defaultEcdPolicyGroup.ID().ToIDOutput().ToStringOutput(),
    			BundleId:         pulumi.String(_default.Bundles[0].Id),
    			EndUserIds: pulumi.StringArray{
    				defaultUser.ID().ToIDOutput().ToStringOutput(),
    			},
    			AllowBufferCount: pulumi.Int(1),
    		})
    		if err != nil {
    			return err
    		}
    		defaultGetGroups := ecddesktop.GetGroupsOutput(ctx, ecddesktop.GetGroupsOutputArgs{
    			Ids: pulumi.StringArray{
    				defaultGroup.ID().ToIDOutput().ToStringOutput(),
    			},
    			NameRegex: defaultGroup.DesktopGroupName,
    		}, nil)
    		ctx.Export("alicloudEcdDesktopGroupExampleId", defaultGetGroups.ApplyT(func(defaultGetGroups ecddesktop.GetGroupsResult) (*string, error) {
    			return defaultGetGroups.Groups[0].Id, nil
    		}).(pulumi.StringPtrOutput))
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var name = config.Get("name") ?? "terraform-example";
        var @default = AliCloud.Eds.GetBundles.Invoke(new()
        {
            BundleType = "SYSTEM",
        });
    
        var defaultSimpleOfficeSite = new AliCloud.Eds.SimpleOfficeSite("default", new()
        {
            CidrBlock = "172.16.0.0/12",
            DesktopAccessType = "Internet",
            OfficeSiteName = name,
        });
    
        var defaultEcdPolicyGroup = new AliCloud.Eds.EcdPolicyGroup("default", new()
        {
            PolicyGroupName = name,
            Clipboard = "readwrite",
            LocalDrive = "read",
            AuthorizeAccessPolicyRules = new[]
            {
                new AliCloud.Eds.Inputs.EcdPolicyGroupAuthorizeAccessPolicyRuleArgs
                {
                    Description = name,
                    CidrIp = "1.2.3.4/24",
                },
            },
            AuthorizeSecurityPolicyRules = new[]
            {
                new AliCloud.Eds.Inputs.EcdPolicyGroupAuthorizeSecurityPolicyRuleArgs
                {
                    Type = "inflow",
                    Policy = "accept",
                    Description = name,
                    PortRange = "80/80",
                    IpProtocol = "TCP",
                    Priority = "1",
                    CidrIp = "0.0.0.0/0",
                },
            },
        });
    
        var defaultUser = new AliCloud.Eds.User("default", new()
        {
            EndUserId = "terraform-example-user",
            Email = "terraform-example@example.com",
            Password = "Example12345",
        });
    
        var defaultGroup = new AliCloud.EcdDesktop.Group("default", new()
        {
            DesktopGroupName = name,
            OfficeSiteId = defaultSimpleOfficeSite.Id,
            PolicyGroupId = defaultEcdPolicyGroup.Id,
            BundleId = @default.Apply(@default => @default.Apply(getBundlesResult => getBundlesResult.Bundles[0]?.Id)),
            EndUserIds = new[]
            {
                defaultUser.Id,
            },
            AllowBufferCount = 1,
        });
    
        var defaultGetGroups = AliCloud.EcdDesktop.GetGroups.Invoke(new()
        {
            Ids = new[]
            {
                defaultGroup.Id,
            },
            NameRegex = defaultGroup.DesktopGroupName,
        });
    
        return new Dictionary<string, object?>
        {
            ["alicloudEcdDesktopGroupExampleId"] = defaultGetGroups.Apply(getGroupsResult => getGroupsResult.Groups[0]?.Id),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.eds.EdsFunctions;
    import com.pulumi.alicloud.eds.inputs.GetBundlesArgs;
    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.User;
    import com.pulumi.alicloud.eds.UserArgs;
    import com.pulumi.alicloud.ecddesktop.Group;
    import com.pulumi.alicloud.ecddesktop.GroupArgs;
    import com.pulumi.alicloud.ecddesktop.EcddesktopFunctions;
    import com.pulumi.alicloud.ecddesktop.inputs.GetGroupsArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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");
            final var default = EdsFunctions.getBundles(GetBundlesArgs.builder()
                .bundleType("SYSTEM")
                .build());
    
            var defaultSimpleOfficeSite = new SimpleOfficeSite("defaultSimpleOfficeSite", SimpleOfficeSiteArgs.builder()
                .cidrBlock("172.16.0.0/12")
                .desktopAccessType("Internet")
                .officeSiteName(name)
                .build());
    
            var defaultEcdPolicyGroup = new EcdPolicyGroup("defaultEcdPolicyGroup", EcdPolicyGroupArgs.builder()
                .policyGroupName(name)
                .clipboard("readwrite")
                .localDrive("read")
                .authorizeAccessPolicyRules(EcdPolicyGroupAuthorizeAccessPolicyRuleArgs.builder()
                    .description(name)
                    .cidrIp("1.2.3.4/24")
                    .build())
                .authorizeSecurityPolicyRules(EcdPolicyGroupAuthorizeSecurityPolicyRuleArgs.builder()
                    .type("inflow")
                    .policy("accept")
                    .description(name)
                    .portRange("80/80")
                    .ipProtocol("TCP")
                    .priority("1")
                    .cidrIp("0.0.0.0/0")
                    .build())
                .build());
    
            var defaultUser = new User("defaultUser", UserArgs.builder()
                .endUserId("terraform-example-user")
                .email("terraform-example@example.com")
                .password("Example12345")
                .build());
    
            var defaultGroup = new Group("defaultGroup", GroupArgs.builder()
                .desktopGroupName(name)
                .officeSiteId(defaultSimpleOfficeSite.id())
                .policyGroupId(defaultEcdPolicyGroup.id())
                .bundleId(default_.bundles()[0].id())
                .endUserIds(defaultUser.id())
                .allowBufferCount(1)
                .build());
    
            final var defaultGetGroups = EcddesktopFunctions.getGroups(GetGroupsArgs.builder()
                .ids(defaultGroup.id())
                .nameRegex(defaultGroup.desktopGroupName())
                .build());
    
            ctx.export("alicloudEcdDesktopGroupExampleId", defaultGetGroups.applyValue(_defaultGetGroups -> _defaultGetGroups.groups()[0].id()));
        }
    }
    
    configuration:
      name:
        type: string
        default: terraform-example
    resources:
      defaultSimpleOfficeSite:
        type: alicloud:eds:SimpleOfficeSite
        name: default
        properties:
          cidrBlock: 172.16.0.0/12
          desktopAccessType: Internet
          officeSiteName: ${name}
      defaultEcdPolicyGroup:
        type: alicloud:eds:EcdPolicyGroup
        name: default
        properties:
          policyGroupName: ${name}
          clipboard: readwrite
          localDrive: read
          authorizeAccessPolicyRules:
            - description: ${name}
              cidrIp: 1.2.3.4/24
          authorizeSecurityPolicyRules:
            - type: inflow
              policy: accept
              description: ${name}
              portRange: 80/80
              ipProtocol: TCP
              priority: '1'
              cidrIp: 0.0.0.0/0
      defaultUser:
        type: alicloud:eds:User
        name: default
        properties:
          endUserId: terraform-example-user
          email: terraform-example@example.com
          password: Example12345
      defaultGroup:
        type: alicloud:ecddesktop:Group
        name: default
        properties:
          desktopGroupName: ${name}
          officeSiteId: ${defaultSimpleOfficeSite.id}
          policyGroupId: ${defaultEcdPolicyGroup.id}
          bundleId: ${default.bundles[0].id}
          endUserIds:
            - ${defaultUser.id}
          allowBufferCount: 1
    variables:
      default:
        fn::invoke:
          function: alicloud:eds:getBundles
          arguments:
            bundleType: SYSTEM
      defaultGetGroups:
        fn::invoke:
          function: alicloud:ecddesktop:getGroups
          arguments:
            ids:
              - ${defaultGroup.id}
            nameRegex: ${defaultGroup.desktopGroupName}
    outputs:
      alicloudEcdDesktopGroupExampleId: ${defaultGetGroups.groups[0].id}
    
    pulumi {
      required_providers {
        alicloud = {
          source = "pulumi/alicloud"
        }
      }
    }
    
    data "alicloud_eds_getbundles" "default" {
      bundle_type = "SYSTEM"
    }
    data "alicloud_ecddesktop_getgroups" "defaultGetGroups" {
      ids        = [alicloud_ecddesktop_group.default.id]
      name_regex = alicloud_ecddesktop_group.default.desktop_group_name
    }
    
    resource "alicloud_eds_simpleofficesite" "default" {
      cidr_block          = "172.16.0.0/12"
      desktop_access_type = "Internet"
      office_site_name    = var.name
    }
    resource "alicloud_eds_ecdpolicygroup" "default" {
      policy_group_name = var.name
      clipboard         = "readwrite"
      local_drive       = "read"
      authorize_access_policy_rules {
        description = var.name
        cidr_ip     = "1.2.3.4/24"
      }
      authorize_security_policy_rules {
        type        = "inflow"
        policy      = "accept"
        description = var.name
        port_range  = "80/80"
        ip_protocol = "TCP"
        priority    = "1"
        cidr_ip     = "0.0.0.0/0"
      }
    }
    resource "alicloud_eds_user" "default" {
      end_user_id = "terraform-example-user"
      email       = "terraform-example@example.com"
      password    = "Example12345"
    }
    resource "alicloud_ecddesktop_group" "default" {
      desktop_group_name = var.name
      office_site_id     = alicloud_eds_simpleofficesite.default.id
      policy_group_id    = alicloud_eds_ecdpolicygroup.default.id
      bundle_id          = data.alicloud_eds_getbundles.default.bundles[0].id
      end_user_ids       = [alicloud_eds_user.default.id]
      allow_buffer_count = 1
    }
    variable "name" {
      type    = string
      default = "terraform-example"
    }
    output "alicloudEcdDesktopGroupExampleId" {
      value = data.alicloud_ecddesktop_getgroups.defaultGetGroups.groups[0].id
    }
    

    Using getGroups

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
    function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOutputOptions): Output<GetGroupsResult>
    def get_groups(desktop_group_id: Optional[str] = None,
                   desktop_group_name: Optional[str] = None,
                   enable_details: Optional[bool] = None,
                   ids: Optional[Sequence[str]] = None,
                   name_regex: Optional[str] = None,
                   office_site_id: Optional[str] = None,
                   output_file: Optional[str] = None,
                   period_unit: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetGroupsResult
    def get_groups_output(desktop_group_id: pulumi.Input[Optional[str]] = None,
                   desktop_group_name: pulumi.Input[Optional[str]] = None,
                   enable_details: pulumi.Input[Optional[bool]] = None,
                   ids: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                   name_regex: pulumi.Input[Optional[str]] = None,
                   office_site_id: pulumi.Input[Optional[str]] = None,
                   output_file: pulumi.Input[Optional[str]] = None,
                   period_unit: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetGroupsResult]
    func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
    func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput

    > Note: This function is named GetGroups in the Go SDK.

    public static class GetGroups 
    {
        public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
    public static Output<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
    public static Output<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: alicloud:ecddesktop/getGroups:getGroups
      arguments:
        # arguments dictionary
    data "alicloud_ecddesktop_get_groups" "name" {
        # arguments
    }

    The following arguments are supported:

    DesktopGroupId string
    The ID of the desktop group.
    DesktopGroupName string
    The name of the desktop group. Fuzzy search is supported.
    EnableDetails bool
    Default to false. Set it to true can output more details about resource attributes.
    Ids List<string>
    A list of Desktop Group IDs.
    NameRegex string
    A regex string to filter results by Desktop Group name.
    OfficeSiteId string
    The ID of the office network to which the desktop groups belong.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    PeriodUnit string
    The subscription duration unit of the desktop groups. Valid values: Month and Year.
    DesktopGroupId string
    The ID of the desktop group.
    DesktopGroupName string
    The name of the desktop group. Fuzzy search is supported.
    EnableDetails bool
    Default to false. Set it to true can output more details about resource attributes.
    Ids []string
    A list of Desktop Group IDs.
    NameRegex string
    A regex string to filter results by Desktop Group name.
    OfficeSiteId string
    The ID of the office network to which the desktop groups belong.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    PeriodUnit string
    The subscription duration unit of the desktop groups. Valid values: Month and Year.
    desktop_group_id string
    The ID of the desktop group.
    desktop_group_name string
    The name of the desktop group. Fuzzy search is supported.
    enable_details bool
    Default to false. Set it to true can output more details about resource attributes.
    ids list(string)
    A list of Desktop Group IDs.
    name_regex string
    A regex string to filter results by Desktop Group name.
    office_site_id string
    The ID of the office network to which the desktop groups belong.
    output_file string
    File name where to save data source results (after running pulumi preview).
    period_unit string
    The subscription duration unit of the desktop groups. Valid values: Month and Year.
    desktopGroupId String
    The ID of the desktop group.
    desktopGroupName String
    The name of the desktop group. Fuzzy search is supported.
    enableDetails Boolean
    Default to false. Set it to true can output more details about resource attributes.
    ids List<String>
    A list of Desktop Group IDs.
    nameRegex String
    A regex string to filter results by Desktop Group name.
    officeSiteId String
    The ID of the office network to which the desktop groups belong.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    periodUnit String
    The subscription duration unit of the desktop groups. Valid values: Month and Year.
    desktopGroupId string
    The ID of the desktop group.
    desktopGroupName string
    The name of the desktop group. Fuzzy search is supported.
    enableDetails boolean
    Default to false. Set it to true can output more details about resource attributes.
    ids string[]
    A list of Desktop Group IDs.
    nameRegex string
    A regex string to filter results by Desktop Group name.
    officeSiteId string
    The ID of the office network to which the desktop groups belong.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    periodUnit string
    The subscription duration unit of the desktop groups. Valid values: Month and Year.
    desktop_group_id str
    The ID of the desktop group.
    desktop_group_name str
    The name of the desktop group. Fuzzy search is supported.
    enable_details bool
    Default to false. Set it to true can output more details about resource attributes.
    ids Sequence[str]
    A list of Desktop Group IDs.
    name_regex str
    A regex string to filter results by Desktop Group name.
    office_site_id str
    The ID of the office network to which the desktop groups belong.
    output_file str
    File name where to save data source results (after running pulumi preview).
    period_unit str
    The subscription duration unit of the desktop groups. Valid values: Month and Year.
    desktopGroupId String
    The ID of the desktop group.
    desktopGroupName String
    The name of the desktop group. Fuzzy search is supported.
    enableDetails Boolean
    Default to false. Set it to true can output more details about resource attributes.
    ids List<String>
    A list of Desktop Group IDs.
    nameRegex String
    A regex string to filter results by Desktop Group name.
    officeSiteId String
    The ID of the office network to which the desktop groups belong.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    periodUnit String
    The subscription duration unit of the desktop groups. Valid values: Month and Year.

    getGroups Result

    The following output properties are available:

    Groups List<Pulumi.AliCloud.ecdDesktop.Outputs.GetGroupsGroup>
    A list of Desktop Group Entries. Each element contains the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    A list of Desktop Group IDs.
    Names List<string>
    A list of name of Desktop Groups.
    DesktopGroupId string
    The ID of the desktop group.
    DesktopGroupName string
    The name of the desktop group.
    EnableDetails bool
    NameRegex string
    OfficeSiteId string
    The ID of the office network.
    OutputFile string
    PeriodUnit string
    Groups []GetGroupsGroup
    A list of Desktop Group Entries. Each element contains the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    A list of Desktop Group IDs.
    Names []string
    A list of name of Desktop Groups.
    DesktopGroupId string
    The ID of the desktop group.
    DesktopGroupName string
    The name of the desktop group.
    EnableDetails bool
    NameRegex string
    OfficeSiteId string
    The ID of the office network.
    OutputFile string
    PeriodUnit string
    groups list(object)
    A list of Desktop Group Entries. Each element contains the following attributes:
    id string
    The provider-assigned unique ID for this managed resource.
    ids list(string)
    A list of Desktop Group IDs.
    names list(string)
    A list of name of Desktop Groups.
    desktop_group_id string
    The ID of the desktop group.
    desktop_group_name string
    The name of the desktop group.
    enable_details bool
    name_regex string
    office_site_id string
    The ID of the office network.
    output_file string
    period_unit string
    groups List<GetGroupsGroup>
    A list of Desktop Group Entries. Each element contains the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of Desktop Group IDs.
    names List<String>
    A list of name of Desktop Groups.
    desktopGroupId String
    The ID of the desktop group.
    desktopGroupName String
    The name of the desktop group.
    enableDetails Boolean
    nameRegex String
    officeSiteId String
    The ID of the office network.
    outputFile String
    periodUnit String
    groups GetGroupsGroup[]
    A list of Desktop Group Entries. Each element contains the following attributes:
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    A list of Desktop Group IDs.
    names string[]
    A list of name of Desktop Groups.
    desktopGroupId string
    The ID of the desktop group.
    desktopGroupName string
    The name of the desktop group.
    enableDetails boolean
    nameRegex string
    officeSiteId string
    The ID of the office network.
    outputFile string
    periodUnit string
    groups Sequence[GetGroupsGroup]
    A list of Desktop Group Entries. Each element contains the following attributes:
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    A list of Desktop Group IDs.
    names Sequence[str]
    A list of name of Desktop Groups.
    desktop_group_id str
    The ID of the desktop group.
    desktop_group_name str
    The name of the desktop group.
    enable_details bool
    name_regex str
    office_site_id str
    The ID of the office network.
    output_file str
    period_unit str
    groups List<Property Map>
    A list of Desktop Group Entries. Each element contains the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of Desktop Group IDs.
    names List<String>
    A list of name of Desktop Groups.
    desktopGroupId String
    The ID of the desktop group.
    desktopGroupName String
    The name of the desktop group.
    enableDetails Boolean
    nameRegex String
    officeSiteId String
    The ID of the office network.
    outputFile String
    periodUnit String

    Supporting Types

    GetGroupsGroup

    AllowAutoSetup int
    NOTE: This field is only available when enableDetails is true. Whether cloud desktops can be automatically created for the subscription desktop group.
    AllowBufferCount int
    NOTE: This field is only available when enableDetails is true. The number of cloud desktops that are reserved in the desktop group.
    BundleId string
    The ID of the desktop template.
    Comments string
    The remarks of the desktop group.
    Cpu int
    The number of vCPUs.
    CreateTime string
    The time when the desktop group was created. The time follows the ISO 8601 standard in UTC.
    Creator string
    The ID of the Alibaba Cloud account that created the desktop group.
    DataDiskCategory string
    The category of the data disk.
    DataDiskSize string
    The size of the data disk. Unit: GiB.
    DesktopGroupId string
    The ID of the desktop group.
    DesktopGroupName string
    The name of the desktop group. Fuzzy search is supported.
    DirectoryId string
    The ID of the directory.
    DirectoryType string
    The type of the directory.
    EndUserCount int
    The number of end users authorized to use the desktop group.
    EndUserIds List<string>
    NOTE: This field is only available when enableDetails is true. The list of IDs of the end users authorized to use the desktop group.
    ExpiredTime string
    The time when the subscription desktop group expires. The time follows the ISO 8601 standard in UTC.
    GpuCount double
    The number of GPUs.
    GpuSpec string
    The GPU specifications.
    Id string
    The ID of the resource supplied above.
    KeepDuration int
    The retention duration of a session after it is disconnected. Unit: milliseconds.
    MaxDesktopsCount int
    The maximum number of cloud desktops that the desktop group can contain.
    Memory int
    The memory size. Unit: MiB.
    MinDesktopsCount int
    The minimum number of cloud desktops that the desktop group automatically creates.
    OfficeSiteId string
    The ID of the office network to which the desktop groups belong.
    OfficeSiteName string
    The name of the office network.
    OfficeSiteType string
    The type of the account system of the office network.
    OwnBundleName string
    The name of the desktop template.
    PayType string
    The billing method.
    PolicyGroupId string
    The ID of the policy group.
    PolicyGroupName string
    The name of the policy group.
    ResType int
    NOTE: This field is only available when enableDetails is true. The type of the resource.
    SystemDiskCategory string
    The category of the system disk.
    SystemDiskSize int
    The size of the system disk. Unit: GiB.
    AllowAutoSetup int
    NOTE: This field is only available when enableDetails is true. Whether cloud desktops can be automatically created for the subscription desktop group.
    AllowBufferCount int
    NOTE: This field is only available when enableDetails is true. The number of cloud desktops that are reserved in the desktop group.
    BundleId string
    The ID of the desktop template.
    Comments string
    The remarks of the desktop group.
    Cpu int
    The number of vCPUs.
    CreateTime string
    The time when the desktop group was created. The time follows the ISO 8601 standard in UTC.
    Creator string
    The ID of the Alibaba Cloud account that created the desktop group.
    DataDiskCategory string
    The category of the data disk.
    DataDiskSize string
    The size of the data disk. Unit: GiB.
    DesktopGroupId string
    The ID of the desktop group.
    DesktopGroupName string
    The name of the desktop group. Fuzzy search is supported.
    DirectoryId string
    The ID of the directory.
    DirectoryType string
    The type of the directory.
    EndUserCount int
    The number of end users authorized to use the desktop group.
    EndUserIds []string
    NOTE: This field is only available when enableDetails is true. The list of IDs of the end users authorized to use the desktop group.
    ExpiredTime string
    The time when the subscription desktop group expires. The time follows the ISO 8601 standard in UTC.
    GpuCount float64
    The number of GPUs.
    GpuSpec string
    The GPU specifications.
    Id string
    The ID of the resource supplied above.
    KeepDuration int
    The retention duration of a session after it is disconnected. Unit: milliseconds.
    MaxDesktopsCount int
    The maximum number of cloud desktops that the desktop group can contain.
    Memory int
    The memory size. Unit: MiB.
    MinDesktopsCount int
    The minimum number of cloud desktops that the desktop group automatically creates.
    OfficeSiteId string
    The ID of the office network to which the desktop groups belong.
    OfficeSiteName string
    The name of the office network.
    OfficeSiteType string
    The type of the account system of the office network.
    OwnBundleName string
    The name of the desktop template.
    PayType string
    The billing method.
    PolicyGroupId string
    The ID of the policy group.
    PolicyGroupName string
    The name of the policy group.
    ResType int
    NOTE: This field is only available when enableDetails is true. The type of the resource.
    SystemDiskCategory string
    The category of the system disk.
    SystemDiskSize int
    The size of the system disk. Unit: GiB.
    allow_auto_setup number
    NOTE: This field is only available when enableDetails is true. Whether cloud desktops can be automatically created for the subscription desktop group.
    allow_buffer_count number
    NOTE: This field is only available when enableDetails is true. The number of cloud desktops that are reserved in the desktop group.
    bundle_id string
    The ID of the desktop template.
    comments string
    The remarks of the desktop group.
    cpu number
    The number of vCPUs.
    create_time string
    The time when the desktop group was created. The time follows the ISO 8601 standard in UTC.
    creator string
    The ID of the Alibaba Cloud account that created the desktop group.
    data_disk_category string
    The category of the data disk.
    data_disk_size string
    The size of the data disk. Unit: GiB.
    desktop_group_id string
    The ID of the desktop group.
    desktop_group_name string
    The name of the desktop group. Fuzzy search is supported.
    directory_id string
    The ID of the directory.
    directory_type string
    The type of the directory.
    end_user_count number
    The number of end users authorized to use the desktop group.
    end_user_ids list(string)
    NOTE: This field is only available when enableDetails is true. The list of IDs of the end users authorized to use the desktop group.
    expired_time string
    The time when the subscription desktop group expires. The time follows the ISO 8601 standard in UTC.
    gpu_count number
    The number of GPUs.
    gpu_spec string
    The GPU specifications.
    id string
    The ID of the resource supplied above.
    keep_duration number
    The retention duration of a session after it is disconnected. Unit: milliseconds.
    max_desktops_count number
    The maximum number of cloud desktops that the desktop group can contain.
    memory number
    The memory size. Unit: MiB.
    min_desktops_count number
    The minimum number of cloud desktops that the desktop group automatically creates.
    office_site_id string
    The ID of the office network to which the desktop groups belong.
    office_site_name string
    The name of the office network.
    office_site_type string
    The type of the account system of the office network.
    own_bundle_name string
    The name of the desktop template.
    pay_type string
    The billing method.
    policy_group_id string
    The ID of the policy group.
    policy_group_name string
    The name of the policy group.
    res_type number
    NOTE: This field is only available when enableDetails is true. The type of the resource.
    system_disk_category string
    The category of the system disk.
    system_disk_size number
    The size of the system disk. Unit: GiB.
    allowAutoSetup Integer
    NOTE: This field is only available when enableDetails is true. Whether cloud desktops can be automatically created for the subscription desktop group.
    allowBufferCount Integer
    NOTE: This field is only available when enableDetails is true. The number of cloud desktops that are reserved in the desktop group.
    bundleId String
    The ID of the desktop template.
    comments String
    The remarks of the desktop group.
    cpu Integer
    The number of vCPUs.
    createTime String
    The time when the desktop group was created. The time follows the ISO 8601 standard in UTC.
    creator String
    The ID of the Alibaba Cloud account that created the desktop group.
    dataDiskCategory String
    The category of the data disk.
    dataDiskSize String
    The size of the data disk. Unit: GiB.
    desktopGroupId String
    The ID of the desktop group.
    desktopGroupName String
    The name of the desktop group. Fuzzy search is supported.
    directoryId String
    The ID of the directory.
    directoryType String
    The type of the directory.
    endUserCount Integer
    The number of end users authorized to use the desktop group.
    endUserIds List<String>
    NOTE: This field is only available when enableDetails is true. The list of IDs of the end users authorized to use the desktop group.
    expiredTime String
    The time when the subscription desktop group expires. The time follows the ISO 8601 standard in UTC.
    gpuCount Double
    The number of GPUs.
    gpuSpec String
    The GPU specifications.
    id String
    The ID of the resource supplied above.
    keepDuration Integer
    The retention duration of a session after it is disconnected. Unit: milliseconds.
    maxDesktopsCount Integer
    The maximum number of cloud desktops that the desktop group can contain.
    memory Integer
    The memory size. Unit: MiB.
    minDesktopsCount Integer
    The minimum number of cloud desktops that the desktop group automatically creates.
    officeSiteId String
    The ID of the office network to which the desktop groups belong.
    officeSiteName String
    The name of the office network.
    officeSiteType String
    The type of the account system of the office network.
    ownBundleName String
    The name of the desktop template.
    payType String
    The billing method.
    policyGroupId String
    The ID of the policy group.
    policyGroupName String
    The name of the policy group.
    resType Integer
    NOTE: This field is only available when enableDetails is true. The type of the resource.
    systemDiskCategory String
    The category of the system disk.
    systemDiskSize Integer
    The size of the system disk. Unit: GiB.
    allowAutoSetup number
    NOTE: This field is only available when enableDetails is true. Whether cloud desktops can be automatically created for the subscription desktop group.
    allowBufferCount number
    NOTE: This field is only available when enableDetails is true. The number of cloud desktops that are reserved in the desktop group.
    bundleId string
    The ID of the desktop template.
    comments string
    The remarks of the desktop group.
    cpu number
    The number of vCPUs.
    createTime string
    The time when the desktop group was created. The time follows the ISO 8601 standard in UTC.
    creator string
    The ID of the Alibaba Cloud account that created the desktop group.
    dataDiskCategory string
    The category of the data disk.
    dataDiskSize string
    The size of the data disk. Unit: GiB.
    desktopGroupId string
    The ID of the desktop group.
    desktopGroupName string
    The name of the desktop group. Fuzzy search is supported.
    directoryId string
    The ID of the directory.
    directoryType string
    The type of the directory.
    endUserCount number
    The number of end users authorized to use the desktop group.
    endUserIds string[]
    NOTE: This field is only available when enableDetails is true. The list of IDs of the end users authorized to use the desktop group.
    expiredTime string
    The time when the subscription desktop group expires. The time follows the ISO 8601 standard in UTC.
    gpuCount number
    The number of GPUs.
    gpuSpec string
    The GPU specifications.
    id string
    The ID of the resource supplied above.
    keepDuration number
    The retention duration of a session after it is disconnected. Unit: milliseconds.
    maxDesktopsCount number
    The maximum number of cloud desktops that the desktop group can contain.
    memory number
    The memory size. Unit: MiB.
    minDesktopsCount number
    The minimum number of cloud desktops that the desktop group automatically creates.
    officeSiteId string
    The ID of the office network to which the desktop groups belong.
    officeSiteName string
    The name of the office network.
    officeSiteType string
    The type of the account system of the office network.
    ownBundleName string
    The name of the desktop template.
    payType string
    The billing method.
    policyGroupId string
    The ID of the policy group.
    policyGroupName string
    The name of the policy group.
    resType number
    NOTE: This field is only available when enableDetails is true. The type of the resource.
    systemDiskCategory string
    The category of the system disk.
    systemDiskSize number
    The size of the system disk. Unit: GiB.
    allow_auto_setup int
    NOTE: This field is only available when enableDetails is true. Whether cloud desktops can be automatically created for the subscription desktop group.
    allow_buffer_count int
    NOTE: This field is only available when enableDetails is true. The number of cloud desktops that are reserved in the desktop group.
    bundle_id str
    The ID of the desktop template.
    comments str
    The remarks of the desktop group.
    cpu int
    The number of vCPUs.
    create_time str
    The time when the desktop group was created. The time follows the ISO 8601 standard in UTC.
    creator str
    The ID of the Alibaba Cloud account that created the desktop group.
    data_disk_category str
    The category of the data disk.
    data_disk_size str
    The size of the data disk. Unit: GiB.
    desktop_group_id str
    The ID of the desktop group.
    desktop_group_name str
    The name of the desktop group. Fuzzy search is supported.
    directory_id str
    The ID of the directory.
    directory_type str
    The type of the directory.
    end_user_count int
    The number of end users authorized to use the desktop group.
    end_user_ids Sequence[str]
    NOTE: This field is only available when enableDetails is true. The list of IDs of the end users authorized to use the desktop group.
    expired_time str
    The time when the subscription desktop group expires. The time follows the ISO 8601 standard in UTC.
    gpu_count float
    The number of GPUs.
    gpu_spec str
    The GPU specifications.
    id str
    The ID of the resource supplied above.
    keep_duration int
    The retention duration of a session after it is disconnected. Unit: milliseconds.
    max_desktops_count int
    The maximum number of cloud desktops that the desktop group can contain.
    memory int
    The memory size. Unit: MiB.
    min_desktops_count int
    The minimum number of cloud desktops that the desktop group automatically creates.
    office_site_id str
    The ID of the office network to which the desktop groups belong.
    office_site_name str
    The name of the office network.
    office_site_type str
    The type of the account system of the office network.
    own_bundle_name str
    The name of the desktop template.
    pay_type str
    The billing method.
    policy_group_id str
    The ID of the policy group.
    policy_group_name str
    The name of the policy group.
    res_type int
    NOTE: This field is only available when enableDetails is true. The type of the resource.
    system_disk_category str
    The category of the system disk.
    system_disk_size int
    The size of the system disk. Unit: GiB.
    allowAutoSetup Number
    NOTE: This field is only available when enableDetails is true. Whether cloud desktops can be automatically created for the subscription desktop group.
    allowBufferCount Number
    NOTE: This field is only available when enableDetails is true. The number of cloud desktops that are reserved in the desktop group.
    bundleId String
    The ID of the desktop template.
    comments String
    The remarks of the desktop group.
    cpu Number
    The number of vCPUs.
    createTime String
    The time when the desktop group was created. The time follows the ISO 8601 standard in UTC.
    creator String
    The ID of the Alibaba Cloud account that created the desktop group.
    dataDiskCategory String
    The category of the data disk.
    dataDiskSize String
    The size of the data disk. Unit: GiB.
    desktopGroupId String
    The ID of the desktop group.
    desktopGroupName String
    The name of the desktop group. Fuzzy search is supported.
    directoryId String
    The ID of the directory.
    directoryType String
    The type of the directory.
    endUserCount Number
    The number of end users authorized to use the desktop group.
    endUserIds List<String>
    NOTE: This field is only available when enableDetails is true. The list of IDs of the end users authorized to use the desktop group.
    expiredTime String
    The time when the subscription desktop group expires. The time follows the ISO 8601 standard in UTC.
    gpuCount Number
    The number of GPUs.
    gpuSpec String
    The GPU specifications.
    id String
    The ID of the resource supplied above.
    keepDuration Number
    The retention duration of a session after it is disconnected. Unit: milliseconds.
    maxDesktopsCount Number
    The maximum number of cloud desktops that the desktop group can contain.
    memory Number
    The memory size. Unit: MiB.
    minDesktopsCount Number
    The minimum number of cloud desktops that the desktop group automatically creates.
    officeSiteId String
    The ID of the office network to which the desktop groups belong.
    officeSiteName String
    The name of the office network.
    officeSiteType String
    The type of the account system of the office network.
    ownBundleName String
    The name of the desktop template.
    payType String
    The billing method.
    policyGroupId String
    The ID of the policy group.
    policyGroupName String
    The name of the policy group.
    resType Number
    NOTE: This field is only available when enableDetails is true. The type of the resource.
    systemDiskCategory String
    The category of the system disk.
    systemDiskSize Number
    The size of the system disk. Unit: GiB.

    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 alicloud logo
    Viewing docs for Alibaba Cloud v3.108.0
    published on Thursday, Sep 17, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial