1. Packages
  2. Wavefront Provider
  3. API Docs
  4. getUserGroup
Wavefront v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi

wavefront.getUserGroup

Explore with Pulumi AI

Wavefront v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi

Use this data source to get information about a Wavefront user group by its ID.

Example Usage

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

// Get the information about the user group.
const example = wavefront.getUserGroup({
    id: "user-group-id",
});
Copy
import pulumi
import pulumi_wavefront as wavefront

# Get the information about the user group.
example = wavefront.get_user_group(id="user-group-id")
Copy
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 the information about the user group.
		_, err := wavefront.LookupUserGroup(ctx, &wavefront.LookupUserGroupArgs{
			Id: "user-group-id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Wavefront = Pulumi.Wavefront;

return await Deployment.RunAsync(() => 
{
    // Get the information about the user group.
    var example = Wavefront.GetUserGroup.Invoke(new()
    {
        Id = "user-group-id",
    });

});
Copy
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.GetUserGroupArgs;
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 the information about the user group.
        final var example = WavefrontFunctions.getUserGroup(GetUserGroupArgs.builder()
            .id("user-group-id")
            .build());

    }
}
Copy
variables:
  # Get the information about the user group.
  example:
    fn::invoke:
      function: wavefront:getUserGroup
      arguments:
        id: user-group-id
Copy

Using getUserGroup

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 getUserGroup(args: GetUserGroupArgs, opts?: InvokeOptions): Promise<GetUserGroupResult>
function getUserGroupOutput(args: GetUserGroupOutputArgs, opts?: InvokeOptions): Output<GetUserGroupResult>
Copy
def get_user_group(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetUserGroupResult
def get_user_group_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetUserGroupResult]
Copy
func LookupUserGroup(ctx *Context, args *LookupUserGroupArgs, opts ...InvokeOption) (*LookupUserGroupResult, error)
func LookupUserGroupOutput(ctx *Context, args *LookupUserGroupOutputArgs, opts ...InvokeOption) LookupUserGroupResultOutput
Copy

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

public static class GetUserGroup 
{
    public static Task<GetUserGroupResult> InvokeAsync(GetUserGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetUserGroupResult> Invoke(GetUserGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUserGroupResult> getUserGroup(GetUserGroupArgs args, InvokeOptions options)
public static Output<GetUserGroupResult> getUserGroup(GetUserGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: wavefront:index/getUserGroup:getUserGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The ID associated with the user group data to be fetched.
Id This property is required. string
The ID associated with the user group data to be fetched.
id This property is required. String
The ID associated with the user group data to be fetched.
id This property is required. string
The ID associated with the user group data to be fetched.
id This property is required. str
The ID associated with the user group data to be fetched.
id This property is required. String
The ID associated with the user group data to be fetched.

getUserGroup Result

The following output properties are available:

Description string
Human-readable description of the group.
Id string
The ID of the group in Wavefront.
Name string
The name of the group in Wavefront.
Roles List<string>
The list of roles associated with the group.
Users List<string>
The list of users assigned to the group.
Description string
Human-readable description of the group.
Id string
The ID of the group in Wavefront.
Name string
The name of the group in Wavefront.
Roles []string
The list of roles associated with the group.
Users []string
The list of users assigned to the group.
description String
Human-readable description of the group.
id String
The ID of the group in Wavefront.
name String
The name of the group in Wavefront.
roles List<String>
The list of roles associated with the group.
users List<String>
The list of users assigned to the group.
description string
Human-readable description of the group.
id string
The ID of the group in Wavefront.
name string
The name of the group in Wavefront.
roles string[]
The list of roles associated with the group.
users string[]
The list of users assigned to the group.
description str
Human-readable description of the group.
id str
The ID of the group in Wavefront.
name str
The name of the group in Wavefront.
roles Sequence[str]
The list of roles associated with the group.
users Sequence[str]
The list of users assigned to the group.
description String
Human-readable description of the group.
id String
The ID of the group in Wavefront.
name String
The name of the group in Wavefront.
roles List<String>
The list of roles associated with the group.
users List<String>
The 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 v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi