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

sonarqube.getUsers

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 user resources

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sonarqube from "@pulumi/sonarqube";
    
    const users = sonarqube.getUsers({});
    
    import pulumi
    import pulumi_sonarqube as sonarqube
    
    users = sonarqube.get_users()
    
    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.GetUsers(ctx, &sonarqube.GetUsersArgs{}, 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 users = Sonarqube.GetUsers.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.GetUsersArgs;
    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 users = SonarqubeFunctions.getUsers();
    
        }
    }
    
    variables:
      users:
        fn::invoke:
          function: sonarqube:getUsers
          arguments: {}
    

    Using getUsers

    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 getUsers(args: GetUsersArgs, opts?: InvokeOptions): Promise<GetUsersResult>
    function getUsersOutput(args: GetUsersOutputArgs, opts?: InvokeOptions): Output<GetUsersResult>
    def get_users(id: Optional[str] = None,
                  search: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUsersResult
    def get_users_output(id: Optional[pulumi.Input[str]] = None,
                  search: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUsersResult]
    func GetUsers(ctx *Context, args *GetUsersArgs, opts ...InvokeOption) (*GetUsersResult, error)
    func GetUsersOutput(ctx *Context, args *GetUsersOutputArgs, opts ...InvokeOption) GetUsersResultOutput

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

    public static class GetUsers 
    {
        public static Task<GetUsersResult> InvokeAsync(GetUsersArgs args, InvokeOptions? opts = null)
        public static Output<GetUsersResult> Invoke(GetUsersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
    public static Output<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
    
    fn::invoke:
      function: sonarqube:index/getUsers:getUsers
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this resource.
    Search string
    Search users by login, name and email.
    Id string
    The ID of this resource.
    Search string
    Search users by login, name and email.
    id String
    The ID of this resource.
    search String
    Search users by login, name and email.
    id string
    The ID of this resource.
    search string
    Search users by login, name and email.
    id str
    The ID of this resource.
    search str
    Search users by login, name and email.
    id String
    The ID of this resource.
    search String
    Search users by login, name and email.

    getUsers Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Users List<GetUsersUser>
    The list of users.
    Search string
    Search users by login, name and email.
    Id string
    The ID of this resource.
    Users []GetUsersUser
    The list of users.
    Search string
    Search users by login, name and email.
    id String
    The ID of this resource.
    users List<GetUsersUser>
    The list of users.
    search String
    Search users by login, name and email.
    id string
    The ID of this resource.
    users GetUsersUser[]
    The list of users.
    search string
    Search users by login, name and email.
    id str
    The ID of this resource.
    users Sequence[GetUsersUser]
    The list of users.
    search str
    Search users by login, name and email.
    id String
    The ID of this resource.
    users List<Property Map>
    The list of users.
    search String
    Search users by login, name and email.

    Supporting Types

    GetUsersUser

    Email string
    IsLocal bool
    LoginName string
    Name string
    Email string
    IsLocal bool
    LoginName string
    Name string
    email String
    isLocal Boolean
    loginName String
    name String
    email string
    isLocal boolean
    loginName string
    name string
    email String
    isLocal Boolean
    loginName 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