Volcengine v0.0.31, May 12 25

Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

volcengine.iam.getUserGroups

Explore with Pulumi AI

Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

Example Usage

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

const fooUserGroup = new volcengine.iam.UserGroup("fooUserGroup", {
    description: "acc-test",
    displayName: "acc-test",
    userGroupName: "acc-test-group",
});
const fooUserGroups = volcengine.iam.getUserGroups({
    query: "acc-test",
});

import pulumi
import pulumi_volcengine as volcengine

foo_user_group = volcengine.iam.UserGroup("fooUserGroup",
    description="acc-test",
    display_name="acc-test",
    user_group_name="acc-test-group")
foo_user_groups = volcengine.iam.get_user_groups(query="acc-test")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/iam"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.NewUserGroup(ctx, "fooUserGroup", &iam.UserGroupArgs{
			Description:   pulumi.String("acc-test"),
			DisplayName:   pulumi.String("acc-test"),
			UserGroupName: pulumi.String("acc-test-group"),
		})
		if err != nil {
			return err
		}
		_, err = iam.GetUserGroups(ctx, &iam.GetUserGroupsArgs{
			Query: pulumi.StringRef("acc-test"),
		}, 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 fooUserGroup = new Volcengine.Iam.UserGroup("fooUserGroup", new()
    {
        Description = "acc-test",
        DisplayName = "acc-test",
        UserGroupName = "acc-test-group",
    });

    var fooUserGroups = Volcengine.Iam.GetUserGroups.Invoke(new()
    {
        Query = "acc-test",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.iam.UserGroup;
import com.pulumi.volcengine.iam.UserGroupArgs;
import com.pulumi.volcengine.iam.IamFunctions;
import com.pulumi.volcengine.iam.inputs.GetUserGroupsArgs;
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) {
        var fooUserGroup = new UserGroup("fooUserGroup", UserGroupArgs.builder()        
            .description("acc-test")
            .displayName("acc-test")
            .userGroupName("acc-test-group")
            .build());

        final var fooUserGroups = IamFunctions.getUserGroups(GetUserGroupsArgs.builder()
            .query("acc-test")
            .build());

    }
}

resources:
  fooUserGroup:
    type: volcengine:iam:UserGroup
    properties:
      description: acc-test
      displayName: acc-test
      userGroupName: acc-test-group
variables:
  fooUserGroups:
    fn::invoke:
      Function: volcengine:iam:getUserGroups
      Arguments:
        query: acc-test

Using getUserGroups

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 getUserGroups(args: GetUserGroupsArgs, opts?: InvokeOptions): Promise<GetUserGroupsResult>
function getUserGroupsOutput(args: GetUserGroupsOutputArgs, opts?: InvokeOptions): Output<GetUserGroupsResult>

def get_user_groups(output_file: Optional[str] = None,
                    query: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetUserGroupsResult
def get_user_groups_output(output_file: Optional[pulumi.Input[str]] = None,
                    query: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetUserGroupsResult]

func GetUserGroups(ctx *Context, args *GetUserGroupsArgs, opts ...InvokeOption) (*GetUserGroupsResult, error)
func GetUserGroupsOutput(ctx *Context, args *GetUserGroupsOutputArgs, opts ...InvokeOption) GetUserGroupsResultOutput

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

public static class GetUserGroups 
{
    public static Task<GetUserGroupsResult> InvokeAsync(GetUserGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetUserGroupsResult> Invoke(GetUserGroupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUserGroupsResult> getUserGroups(GetUserGroupsArgs args, InvokeOptions options)
public static Output<GetUserGroupsResult> getUserGroups(GetUserGroupsArgs args, InvokeOptions options)

fn::invoke:
  function: volcengine:iam/getUserGroups:getUserGroups
  arguments:
    # arguments dictionary

The following arguments are supported:

OutputFile string: File name where to save data source results.
Query string: Fuzzy search, supports searching for user group names, display names, and remarks.

OutputFile string: File name where to save data source results.
Query string: Fuzzy search, supports searching for user group names, display names, and remarks.

outputFile String: File name where to save data source results.
query String: Fuzzy search, supports searching for user group names, display names, and remarks.

outputFile string: File name where to save data source results.
query string: Fuzzy search, supports searching for user group names, display names, and remarks.

output_file str: File name where to save data source results.
query str: Fuzzy search, supports searching for user group names, display names, and remarks.

outputFile String: File name where to save data source results.
query String: Fuzzy search, supports searching for user group names, display names, and remarks.

getUserGroups Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
TotalCount int: The total count of query.
UserGroups List<GetUserGroupsUserGroup>: The collection of query.
OutputFile string
Query string

Id string: The provider-assigned unique ID for this managed resource.
TotalCount int: The total count of query.
UserGroups []GetUserGroupsUserGroup: The collection of query.
OutputFile string
Query string

id String: The provider-assigned unique ID for this managed resource.
totalCount Integer: The total count of query.
userGroups List<GetUserGroupsUserGroup>: The collection of query.
outputFile String
query String

id string: The provider-assigned unique ID for this managed resource.
totalCount number: The total count of query.
userGroups GetUserGroupsUserGroup[]: The collection of query.
outputFile string
query string

id str: The provider-assigned unique ID for this managed resource.
total_count int: The total count of query.
user_groups Sequence[GetUserGroupsUserGroup]: The collection of query.
output_file str
query str

id String: The provider-assigned unique ID for this managed resource.
totalCount Number: The total count of query.
userGroups List<Property Map>: The collection of query.
outputFile String
query String

Supporting Types

GetUserGroupsUserGroup

AccountId int: The id of the account.
CreateDate string: The creation date of the user group.
Description string: The description of the user group.
DisplayName string: The display name of the user group.
UpdateDate string: The update date of the user group.
UserGroupName string: The name of the user group.

AccountId int: The id of the account.
CreateDate string: The creation date of the user group.
Description string: The description of the user group.
DisplayName string: The display name of the user group.
UpdateDate string: The update date of the user group.
UserGroupName string: The name of the user group.

accountId Integer: The id of the account.
createDate String: The creation date of the user group.
description String: The description of the user group.
displayName String: The display name of the user group.
updateDate String: The update date of the user group.
userGroupName String: The name of the user group.

accountId number: The id of the account.
createDate string: The creation date of the user group.
description string: The description of the user group.
displayName string: The display name of the user group.
updateDate string: The update date of the user group.
userGroupName string: The name of the user group.

account_id int: The id of the account.
create_date str: The creation date of the user group.
description str: The description of the user group.
display_name str: The display name of the user group.
update_date str: The update date of the user group.
user_group_name str: The name of the user group.

accountId Number: The id of the account.
createDate String: The creation date of the user group.
description String: The description of the user group.
displayName String: The display name of the user group.
updateDate String: The update date of the user group.
userGroupName String: The name of the user group.

Package Details

Repository: volcengine volcengine/pulumi-volcengine
License: Apache-2.0
Notes: This Pulumi package is based on the volcengine Terraform Provider.

Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

volcengine/pulumi-volcengine

volcengine.iam.getUserGroups

On this page

On this page

Example Usage

Using getUserGroups

getUserGroups Result

Supporting Types

GetUserGroupsUserGroup

Package Details

On this page

On this page