1. Packages
  2. Sonarqube Provider
  3. API Docs
  4. getGroups
sonarqube 0.16.15 published on Sunday, May 18, 2025 by jdamata

sonarqube.getGroups

Explore with Pulumi AI

sonarqube logo
sonarqube 0.16.15 published on Sunday, May 18, 2025 by jdamata

    Use this data source to get Sonarqube group resources

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sonarqube from "@pulumi/sonarqube";
    
    const groups = sonarqube.getGroups({});
    
    import pulumi
    import pulumi_sonarqube as sonarqube
    
    groups = sonarqube.get_groups()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/sonarqube/sonarqube"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sonarqube.GetGroups(ctx, &sonarqube.GetGroupsArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Sonarqube = Pulumi.Sonarqube;
    
    return await Deployment.RunAsync(() => 
    {
        var groups = Sonarqube.GetGroups.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sonarqube.SonarqubeFunctions;
    import com.pulumi.sonarqube.inputs.GetGroupsArgs;
    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) {
            final var groups = SonarqubeFunctions.getGroups();
    
        }
    }
    
    variables:
      groups:
        fn::invoke:
          function: sonarqube:getGroups
          arguments: {}
    

    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(id: Optional[str] = None,
                   search: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetGroupsResult
    def get_groups_output(id: Optional[pulumi.Input[str]] = None,
                   search: 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: sonarqube:index/getGroups:getGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this resource.
    Search string
    Search groups by name.
    Id string
    The ID of this resource.
    Search string
    Search groups by name.
    id String
    The ID of this resource.
    search String
    Search groups by name.
    id string
    The ID of this resource.
    search string
    Search groups by name.
    id str
    The ID of this resource.
    search str
    Search groups by name.
    id String
    The ID of this resource.
    search String
    Search groups by name.

    getGroups Result

    The following output properties are available:

    Groups List<GetGroupsGroup>
    The list of groups.
    Id string
    The ID of this resource.
    Search string
    Search groups by name.
    Groups []GetGroupsGroup
    The list of groups.
    Id string
    The ID of this resource.
    Search string
    Search groups by name.
    groups List<GetGroupsGroup>
    The list of groups.
    id String
    The ID of this resource.
    search String
    Search groups by name.
    groups GetGroupsGroup[]
    The list of groups.
    id string
    The ID of this resource.
    search string
    Search groups by name.
    groups Sequence[GetGroupsGroup]
    The list of groups.
    id str
    The ID of this resource.
    search str
    Search groups by name.
    groups List<Property Map>
    The list of groups.
    id String
    The ID of this resource.
    search String
    Search groups by name.

    Supporting Types

    GetGroupsGroup

    Description string
    Name string
    Description string
    Name string
    description String
    name String
    description string
    name string
    description String
    name String

    Package Details

    Repository
    sonarqube jdamata/terraform-provider-sonarqube
    License
    Notes
    This Pulumi package is based on the sonarqube Terraform Provider.
    sonarqube logo
    sonarqube 0.16.15 published on Sunday, May 18, 2025 by jdamata