1. Packages
  2. Volcengine
  3. API Docs
  4. cloud_identity
  5. getGroups
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.cloud_identity.getGroups

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of cloud identity groups

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";

const fooGroup: volcengine.cloud_identity.Group[] = [];
for (const range = {value: 0}; range.value < 2; range.value++) {
    fooGroup.push(new volcengine.cloud_identity.Group(`fooGroup-${range.value}`, {
        description: "tf",
        displayName: `tf-test-group-${range.value}`,
        groupName: `acc-test-group-${range.value}`,
        joinType: "Manual",
    }));
}
const fooGroups = volcengine.cloud_identity.getGroups({
    groupName: "acc-test-group",
    joinType: "Manual",
});

    import pulumi
import pulumi_volcengine as volcengine

foo_group = []
for range in [{"value": i} for i in range(0, 2)]:
    foo_group.append(volcengine.cloud_identity.Group(f"fooGroup-{range['value']}",
        description="tf",
        display_name=f"tf-test-group-{range['value']}",
        group_name=f"acc-test-group-{range['value']}",
        join_type="Manual"))
foo_groups = volcengine.cloud_identity.get_groups(group_name="acc-test-group",
    join_type="Manual")

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/cloud_identity"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		var fooGroup []*cloud_identity.Group
		for index := 0; index < 2; index++ {
			key0 := index
			val0 := index
			__res, err := cloud_identity.NewGroup(ctx, fmt.Sprintf("fooGroup-%v", key0), &cloud_identity.GroupArgs{
				Description: pulumi.String("tf"),
				DisplayName: pulumi.String(fmt.Sprintf("tf-test-group-%v", val0)),
				GroupName:   pulumi.String(fmt.Sprintf("acc-test-group-%v", val0)),
				JoinType:    pulumi.String("Manual"),
			})
			if err != nil {
				return err
			}
			fooGroup = append(fooGroup, __res)
		}
		_, err = cloud_identity.GetGroups(ctx, &cloud_identity.GetGroupsArgs{
			GroupName: pulumi.StringRef("acc-test-group"),
			JoinType:  pulumi.StringRef("Manual"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooGroup = new List<Volcengine.Cloud_identity.Group>();
    for (var rangeIndex = 0; rangeIndex < 2; rangeIndex++)
    {
        var range = new { Value = rangeIndex };
        fooGroup.Add(new Volcengine.Cloud_identity.Group($"fooGroup-{range.Value}", new()
        {
            Description = "tf",
            DisplayName = $"tf-test-group-{range.Value}",
            GroupName = $"acc-test-group-{range.Value}",
            JoinType = "Manual",
        }));
    }
    var fooGroups = Volcengine.Cloud_identity.GetGroups.Invoke(new()
    {
        GroupName = "acc-test-group",
        JoinType = "Manual",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.cloud_identity.Group;
import com.pulumi.volcengine.cloud_identity.GroupArgs;
import com.pulumi.volcengine.cloud_identity.Cloud_identityFunctions;
import com.pulumi.volcengine.cloud_identity.inputs.GetGroupsArgs;
import com.pulumi.codegen.internal.KeyedValue;
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) {
        for (var i = 0; i < 2; i++) {
            new Group("fooGroup-" + i, GroupArgs.builder()            
                .description("tf")
                .displayName(String.format("tf-test-group-%s", range.value()))
                .groupName(String.format("acc-test-group-%s", range.value()))
                .joinType("Manual")
                .build());

        
}
        final var fooGroups = Cloud_identityFunctions.getGroups(GetGroupsArgs.builder()
            .groupName("acc-test-group")
            .joinType("Manual")
            .build());

    }
}

    resources:
  fooGroup:
    type: volcengine:cloud_identity:Group
    properties:
      description: tf
      displayName: tf-test-group-${range.value}
      groupName: acc-test-group-${range.value}
      joinType: Manual
    options: {}
variables:
  fooGroups:
    fn::invoke:
      Function: volcengine:cloud_identity:getGroups
      Arguments:
        groupName: acc-test-group
        joinType: Manual

    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?: InvokeOptions): Output<GetGroupsResult>
    def get_groups(display_name: Optional[str] = None,
               group_name: Optional[str] = None,
               join_type: Optional[str] = None,
               name_regex: Optional[str] = None,
               output_file: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(display_name: Optional[pulumi.Input[str]] = None,
               group_name: Optional[pulumi.Input[str]] = None,
               join_type: Optional[pulumi.Input[str]] = None,
               name_regex: Optional[pulumi.Input[str]] = None,
               output_file: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = 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 CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
public static Output<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:cloud_identity/getGroups:getGroups
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DisplayName string
    The display name of cloud identity group.
    GroupName string
    The name of cloud identity group.
    JoinType string
    The join type of cloud identity group. Valid values: Auto, Manual.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    DisplayName string
    The display name of cloud identity group.
    GroupName string
    The name of cloud identity group.
    JoinType string
    The join type of cloud identity group. Valid values: Auto, Manual.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    displayName String
    The display name of cloud identity group.
    groupName String
    The name of cloud identity group.
    joinType String
    The join type of cloud identity group. Valid values: Auto, Manual.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    displayName string
    The display name of cloud identity group.
    groupName string
    The name of cloud identity group.
    joinType string
    The join type of cloud identity group. Valid values: Auto, Manual.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    display_name str
    The display name of cloud identity group.
    group_name str
    The name of cloud identity group.
    join_type str
    The join type of cloud identity group. Valid values: Auto, Manual.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    displayName String
    The display name of cloud identity group.
    groupName String
    The name of cloud identity group.
    joinType String
    The join type of cloud identity group. Valid values: Auto, Manual.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.

    getGroups Result

    The following output properties are available:

    Groups List<GetGroupsGroup>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    DisplayName string
    The display name of the cloud identity group.
    GroupName string
    The name of the cloud identity group.
    JoinType string
    The email of the cloud identity group.
    NameRegex string
    OutputFile string
    Groups []GetGroupsGroup
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    DisplayName string
    The display name of the cloud identity group.
    GroupName string
    The name of the cloud identity group.
    JoinType string
    The email of the cloud identity group.
    NameRegex string
    OutputFile string
    groups List<GetGroupsGroup>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    displayName String
    The display name of the cloud identity group.
    groupName String
    The name of the cloud identity group.
    joinType String
    The email of the cloud identity group.
    nameRegex String
    outputFile String
    groups GetGroupsGroup[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    displayName string
    The display name of the cloud identity group.
    groupName string
    The name of the cloud identity group.
    joinType string
    The email of the cloud identity group.
    nameRegex string
    outputFile string
    groups Sequence[GetGroupsGroup]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    display_name str
    The display name of the cloud identity group.
    group_name str
    The name of the cloud identity group.
    join_type str
    The email of the cloud identity group.
    name_regex str
    output_file str
    groups List<Property Map>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    displayName String
    The display name of the cloud identity group.
    groupName String
    The name of the cloud identity group.
    joinType String
    The email of the cloud identity group.
    nameRegex String
    outputFile String

    Supporting Types

    GetGroupsGroup

    CreatedTime string
    The created time of the cloud identity group.
    Description string
    The description of the cloud identity group.
    DisplayName string
    The display name of cloud identity group.
    GroupId string
    The id of the cloud identity group.
    GroupName string
    The name of cloud identity group.
    Id string
    The id of the cloud identity group.
    JoinType string
    The join type of cloud identity group. Valid values: Auto, Manual.
    Source string
    The source of the cloud identity group.
    UpdatedTime string
    The updated time of the cloud identity group.
    CreatedTime string
    The created time of the cloud identity group.
    Description string
    The description of the cloud identity group.
    DisplayName string
    The display name of cloud identity group.
    GroupId string
    The id of the cloud identity group.
    GroupName string
    The name of cloud identity group.
    Id string
    The id of the cloud identity group.
    JoinType string
    The join type of cloud identity group. Valid values: Auto, Manual.
    Source string
    The source of the cloud identity group.
    UpdatedTime string
    The updated time of the cloud identity group.
    createdTime String
    The created time of the cloud identity group.
    description String
    The description of the cloud identity group.
    displayName String
    The display name of cloud identity group.
    groupId String
    The id of the cloud identity group.
    groupName String
    The name of cloud identity group.
    id String
    The id of the cloud identity group.
    joinType String
    The join type of cloud identity group. Valid values: Auto, Manual.
    source String
    The source of the cloud identity group.
    updatedTime String
    The updated time of the cloud identity group.
    createdTime string
    The created time of the cloud identity group.
    description string
    The description of the cloud identity group.
    displayName string
    The display name of cloud identity group.
    groupId string
    The id of the cloud identity group.
    groupName string
    The name of cloud identity group.
    id string
    The id of the cloud identity group.
    joinType string
    The join type of cloud identity group. Valid values: Auto, Manual.
    source string
    The source of the cloud identity group.
    updatedTime string
    The updated time of the cloud identity group.
    created_time str
    The created time of the cloud identity group.
    description str
    The description of the cloud identity group.
    display_name str
    The display name of cloud identity group.
    group_id str
    The id of the cloud identity group.
    group_name str
    The name of cloud identity group.
    id str
    The id of the cloud identity group.
    join_type str
    The join type of cloud identity group. Valid values: Auto, Manual.
    source str
    The source of the cloud identity group.
    updated_time str
    The updated time of the cloud identity group.
    createdTime String
    The created time of the cloud identity group.
    description String
    The description of the cloud identity group.
    displayName String
    The display name of cloud identity group.
    groupId String
    The id of the cloud identity group.
    groupName String
    The name of cloud identity group.
    id String
    The id of the cloud identity group.
    joinType String
    The join type of cloud identity group. Valid values: Auto, Manual.
    source String
    The source of the cloud identity group.
    updatedTime String
    The updated time of the cloud identity group.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate