pulumi-gitlab-kotlin/com.pulumi.gitlab.kotlin/GitlabFunctions/getGroups

getGroups

suspend fun getGroups(argument: GetGroupsPlainArgs): GetGroupsResult

The gitlab.getGroups data source allows details of multiple groups to be retrieved given some optional filter criteria.

Some attributes might not be returned depending on if you're an admin or not. Some available options require administrator privileges. Upstream API: GitLab REST API docs

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.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 example = GitlabFunctions.getGroups(GetGroupsArgs.builder()
            .orderBy("name")
            .sort("desc")
            .build());
        final var example-two = GitlabFunctions.getGroups(GetGroupsArgs.builder()
            .search("GitLab")
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getGroups.

Parameters

argument

A collection of arguments for invoking getGroups.

suspend fun getGroups(orderBy: String? = null, search: String? = null, sort: String? = null, topLevelOnly: Boolean? = null): GetGroupsResult

Return

A collection of values returned by getGroups.

See also

Parameters

orderBy

Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)

search

Search groups by name or path.

sort

Sort groups' list in asc or desc order. (Requires administrator privileges)

topLevelOnly

Limit to top level groups, excluding all subgroups.

suspend fun getGroups(argument: suspend GetGroupsPlainArgsBuilder.() -> Unit): GetGroupsResult

Return

A collection of values returned by getGroups.

See also

Parameters

argument

Builder for com.pulumi.gitlab.kotlin.inputs.GetGroupsPlainArgs.