Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Wavefront Provider
  3. API Docs
  4. getUserGroups
Wavefront v3.1.9 published on Tuesday, Apr 29, 2025 by Pulumi
pulumi/pulumi-wavefront

wavefront.getUserGroups

Explore with Pulumi AI

wavefront logo
Wavefront v3.1.9 published on Tuesday, Apr 29, 2025 by Pulumi
pulumi/pulumi-wavefront

    Use this data source to get all User Groups in Wavefront.

    Example Usage

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

// Get all user groups
const groups = wavefront.getUserGroups({
    limit: 10,
    offset: 0,
});

    import pulumi
import pulumi_wavefront as wavefront

# Get all user groups
groups = wavefront.get_user_groups(limit=10,
    offset=0)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get all user groups
		_, err := wavefront.GetUserGroups(ctx, &wavefront.GetUserGroupsArgs{
			Limit:  pulumi.IntRef(10),
			Offset: pulumi.IntRef(0),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Get all user groups
    var groups = Wavefront.GetUserGroups.Invoke(new()
    {
        Limit = 10,
        Offset = 0,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.wavefront.WavefrontFunctions;
import com.pulumi.wavefront.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) {
        // Get all user groups
        final var groups = WavefrontFunctions.getUserGroups(GetUserGroupsArgs.builder()
            .limit(10)
            .offset(0)
            .build());

    }
}

    variables:
  # Get all user groups
  groups:
    fn::invoke:
      function: wavefront:getUserGroups
      arguments:
        limit: 10
        offset: 0

    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(limit: Optional[int] = None,
                    offset: Optional[int] = None,
                    opts: Optional[InvokeOptions] = None) -> GetUserGroupsResult
def get_user_groups_output(limit: Optional[pulumi.Input[int]] = None,
                    offset: Optional[pulumi.Input[int]] = 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: wavefront:index/getUserGroups:getUserGroups
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Limit int
    Limit is the maximum number of results to be returned. Defaults to 100.
    Offset int
    Offset is the offset from the first result to be returned. Defaults to 0.
    Limit int
    Limit is the maximum number of results to be returned. Defaults to 100.
    Offset int
    Offset is the offset from the first result to be returned. Defaults to 0.
    limit Integer
    Limit is the maximum number of results to be returned. Defaults to 100.
    offset Integer
    Offset is the offset from the first result to be returned. Defaults to 0.
    limit number
    Limit is the maximum number of results to be returned. Defaults to 100.
    offset number
    Offset is the offset from the first result to be returned. Defaults to 0.
    limit int
    Limit is the maximum number of results to be returned. Defaults to 100.
    offset int
    Offset is the offset from the first result to be returned. Defaults to 0.
    limit Number
    Limit is the maximum number of results to be returned. Defaults to 100.
    offset Number
    Offset is the offset from the first result to be returned. Defaults to 0.

    getUserGroups Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    UserGroups List<GetUserGroupsUserGroup>
    List of user groups.
    Limit int
    Offset int
    Id string
    The provider-assigned unique ID for this managed resource.
    UserGroups []GetUserGroupsUserGroup
    List of user groups.
    Limit int
    Offset int
    id String
    The provider-assigned unique ID for this managed resource.
    userGroups List<GetUserGroupsUserGroup>
    List of user groups.
    limit Integer
    offset Integer
    id string
    The provider-assigned unique ID for this managed resource.
    userGroups GetUserGroupsUserGroup[]
    List of user groups.
    limit number
    offset number
    id str
    The provider-assigned unique ID for this managed resource.
    user_groups Sequence[GetUserGroupsUserGroup]
    List of user groups.
    limit int
    offset int
    id String
    The provider-assigned unique ID for this managed resource.
    userGroups List<Property Map>
    List of user groups.
    limit Number
    offset Number

    Supporting Types

    GetUserGroupsUserGroup

    Description string
    The group description.
    Id string
    The group ID.
    Name string
    The group name.
    Roles List<string>
    List of roles associated with the group.
    Users List<string>
    List of users assigned to the group.
    Description string
    The group description.
    Id string
    The group ID.
    Name string
    The group name.
    Roles []string
    List of roles associated with the group.
    Users []string
    List of users assigned to the group.
    description String
    The group description.
    id String
    The group ID.
    name String
    The group name.
    roles List<String>
    List of roles associated with the group.
    users List<String>
    List of users assigned to the group.
    description string
    The group description.
    id string
    The group ID.
    name string
    The group name.
    roles string[]
    List of roles associated with the group.
    users string[]
    List of users assigned to the group.
    description str
    The group description.
    id str
    The group ID.
    name str
    The group name.
    roles Sequence[str]
    List of roles associated with the group.
    users Sequence[str]
    List of users assigned to the group.
    description String
    The group description.
    id String
    The group ID.
    name String
    The group name.
    roles List<String>
    List of roles associated with the group.
    users List<String>
    List of users assigned to the group.

    Package Details

    Repository
    Wavefront pulumi/pulumi-wavefront
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the wavefront Terraform Provider.
    wavefront logo
    Wavefront v3.1.9 published on Tuesday, Apr 29, 2025 by Pulumi
    pulumi/pulumi-wavefront