Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine.iam.UserGroups
Explore with Pulumi AI
Use this data source to query detailed information of iam user groups
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.UserGroups({
    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.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.UserGroups(ctx, &iam.UserGroupsArgs{
			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.UserGroups.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.UserGroupsArgs;
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.UserGroups(UserGroupsArgs.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:UserGroups
      Arguments:
        query: acc-test
Using UserGroups
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 userGroups(args: UserGroupsArgs, opts?: InvokeOptions): Promise<UserGroupsResult>
function userGroupsOutput(args: UserGroupsOutputArgs, opts?: InvokeOptions): Output<UserGroupsResult>def user_groups(output_file: Optional[str] = None,
                query: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> UserGroupsResult
def user_groups_output(output_file: Optional[pulumi.Input[str]] = None,
                query: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[UserGroupsResult]func UserGroups(ctx *Context, args *UserGroupsArgs, opts ...InvokeOption) (*UserGroupsResult, error)
func UserGroupsOutput(ctx *Context, args *UserGroupsOutputArgs, opts ...InvokeOption) UserGroupsResultOutputpublic static class UserGroups 
{
    public static Task<UserGroupsResult> InvokeAsync(UserGroupsArgs args, InvokeOptions? opts = null)
    public static Output<UserGroupsResult> Invoke(UserGroupsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<UserGroupsResult> userGroups(UserGroupsArgs args, InvokeOptions options)
public static Output<UserGroupsResult> userGroups(UserGroupsArgs args, InvokeOptions options)
fn::invoke:
  function: volcengine:iam:UserGroups
  arguments:
    # arguments dictionaryThe 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.
UserGroups 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<UserGroups User Group> 
- 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 []UserGroups User Group 
- 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<UserGroups User Group> 
- 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 UserGroups User Group[] 
- 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[UserGroups User Group] 
- 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
UserGroupsUserGroup   
- 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.
- UserGroup stringName 
- 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.
- UserGroup stringName 
- 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.
- userGroup StringName 
- 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.
- userGroup stringName 
- 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_ strname 
- 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.
- userGroup StringName 
- 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 volcengineTerraform Provider.