get Groups
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
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = gitlab.getGroups({
orderBy: "name",
sort: "desc",
});
const example-two = gitlab.getGroups({
search: "GitLab",
});
import pulumi
import pulumi_gitlab as gitlab
example = gitlab.get_groups(order_by="name",
sort="desc")
example_two = gitlab.get_groups(search="GitLab")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
var example = GitLab.GetGroups.Invoke(new()
{
OrderBy = "name",
Sort = "desc",
});
var example_two = GitLab.GetGroups.Invoke(new()
{
Search = "GitLab",
});
});
package main
import (
"github.com/pulumi/pulumi-gitlab/sdk/v6/go/gitlab"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := gitlab.GetGroups(ctx, &gitlab.GetGroupsArgs{
OrderBy: pulumi.StringRef("name"),
Sort: pulumi.StringRef("desc"),
}, nil)
if err != nil {
return err
}
_, err = gitlab.GetGroups(ctx, &gitlab.GetGroupsArgs{
Search: pulumi.StringRef("GitLab"),
}, nil)
if err != nil {
return err
}
return nil
})
}
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());
}
}
variables:
example:
fn::invoke:
Function: gitlab:getGroups
Arguments:
orderBy: name
sort: desc
example-two:
fn::invoke:
Function: gitlab:getGroups
Arguments:
search: GitLab
Return
A collection of values returned by getGroups.
Parameters
A collection of arguments for invoking getGroups.
Return
A collection of values returned by getGroups.
Parameters
Order the groups' list by id
, name
, path
, or similarity
. (Requires administrator privileges)
Search groups by name or path.
Sort groups' list in asc or desc order. (Requires administrator privileges)
Limit to top level groups, excluding all subgroups.
See also
Return
A collection of values returned by getGroups.
Parameters
Builder for com.pulumi.gitlab.kotlin.inputs.GetGroupsPlainArgs.