GitLab v4.9.0, Oct 24 22

gitlab.getGroup

The gitlab.Group data source allows details of a group to be retrieved by its id or full path.

Example Usage

using System.Collections.Generic;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var foo = GitLab.GetGroup.Invoke(new()
    {
        FullPath = "foo/bar",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v4/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = gitlab.LookupGroup(ctx, &GetGroupArgs{
			FullPath: pulumi.StringRef("foo/bar"),
		}, 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.GetGroupArgs;
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 foo = GitlabFunctions.getGroup(GetGroupArgs.builder()
            .fullPath("foo/bar")
            .build());

    }
}

import pulumi
import pulumi_gitlab as gitlab

foo = gitlab.get_group(full_path="foo/bar")

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

// By group's full path
const foo = pulumi.output(gitlab.getGroup({
    fullPath: "foo/bar",
}));

variables:
  foo:
    fn::invoke:
      Function: gitlab:getGroup
      Arguments:
        fullPath: foo/bar

Using getGroup

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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>

def get_group(full_path: Optional[str] = None,
              group_id: Optional[int] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(full_path: Optional[pulumi.Input[str]] = None,
              group_id: Optional[pulumi.Input[int]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]

func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

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

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: gitlab:index/getGroup:getGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

FullPath string: The full path of the group.
GroupId int: The ID of the group.

FullPath string: The full path of the group.
GroupId int: The ID of the group.

fullPath String: The full path of the group.
groupId Integer: The ID of the group.

fullPath string: The full path of the group.
groupId number: The ID of the group.

full_path str: The full path of the group.
group_id int: The ID of the group.

fullPath String: The full path of the group.
groupId Number: The ID of the group.

getGroup Result

The following output properties are available:

DefaultBranchProtection int: Whether developers and maintainers can push to the applicable default branch.
Description string: The description of the group.
FullName string: The full name of the group.
FullPath string: The full path of the group.
GroupId int: The ID of the group.
Id string: The provider-assigned unique ID for this managed resource.
LfsEnabled bool: Boolean, is LFS enabled for projects in this group.
Name string: The name of this group.
ParentId int: Integer, ID of the parent group.
Path string: The path of the group.
PreventForkingOutsideGroup bool: When enabled, users can not fork projects from this group to external namespaces.
RequestAccessEnabled bool: Boolean, is request for access enabled to the group.
RunnersToken string: The group level registration token to use during runner setup.
VisibilityLevel string: Visibility level of the group. Possible values are private, internal, public.
WebUrl string: Web URL of the group.

DefaultBranchProtection int: Whether developers and maintainers can push to the applicable default branch.
Description string: The description of the group.
FullName string: The full name of the group.
FullPath string: The full path of the group.
GroupId int: The ID of the group.
Id string: The provider-assigned unique ID for this managed resource.
LfsEnabled bool: Boolean, is LFS enabled for projects in this group.
Name string: The name of this group.
ParentId int: Integer, ID of the parent group.
Path string: The path of the group.
PreventForkingOutsideGroup bool: When enabled, users can not fork projects from this group to external namespaces.
RequestAccessEnabled bool: Boolean, is request for access enabled to the group.
RunnersToken string: The group level registration token to use during runner setup.
VisibilityLevel string: Visibility level of the group. Possible values are private, internal, public.
WebUrl string: Web URL of the group.

defaultBranchProtection Integer: Whether developers and maintainers can push to the applicable default branch.
description String: The description of the group.
fullName String: The full name of the group.
fullPath String: The full path of the group.
groupId Integer: The ID of the group.
id String: The provider-assigned unique ID for this managed resource.
lfsEnabled Boolean: Boolean, is LFS enabled for projects in this group.
name String: The name of this group.
parentId Integer: Integer, ID of the parent group.
path String: The path of the group.
preventForkingOutsideGroup Boolean: When enabled, users can not fork projects from this group to external namespaces.
requestAccessEnabled Boolean: Boolean, is request for access enabled to the group.
runnersToken String: The group level registration token to use during runner setup.
visibilityLevel String: Visibility level of the group. Possible values are private, internal, public.
webUrl String: Web URL of the group.

defaultBranchProtection number: Whether developers and maintainers can push to the applicable default branch.
description string: The description of the group.
fullName string: The full name of the group.
fullPath string: The full path of the group.
groupId number: The ID of the group.
id string: The provider-assigned unique ID for this managed resource.
lfsEnabled boolean: Boolean, is LFS enabled for projects in this group.
name string: The name of this group.
parentId number: Integer, ID of the parent group.
path string: The path of the group.
preventForkingOutsideGroup boolean: When enabled, users can not fork projects from this group to external namespaces.
requestAccessEnabled boolean: Boolean, is request for access enabled to the group.
runnersToken string: The group level registration token to use during runner setup.
visibilityLevel string: Visibility level of the group. Possible values are private, internal, public.
webUrl string: Web URL of the group.

default_branch_protection int: Whether developers and maintainers can push to the applicable default branch.
description str: The description of the group.
full_name str: The full name of the group.
full_path str: The full path of the group.
group_id int: The ID of the group.
id str: The provider-assigned unique ID for this managed resource.
lfs_enabled bool: Boolean, is LFS enabled for projects in this group.
name str: The name of this group.
parent_id int: Integer, ID of the parent group.
path str: The path of the group.
prevent_forking_outside_group bool: When enabled, users can not fork projects from this group to external namespaces.
request_access_enabled bool: Boolean, is request for access enabled to the group.
runners_token str: The group level registration token to use during runner setup.
visibility_level str: Visibility level of the group. Possible values are private, internal, public.
web_url str: Web URL of the group.

defaultBranchProtection Number: Whether developers and maintainers can push to the applicable default branch.
description String: The description of the group.
fullName String: The full name of the group.
fullPath String: The full path of the group.
groupId Number: The ID of the group.
id String: The provider-assigned unique ID for this managed resource.
lfsEnabled Boolean: Boolean, is LFS enabled for projects in this group.
name String: The name of this group.
parentId Number: Integer, ID of the parent group.
path String: The path of the group.
preventForkingOutsideGroup Boolean: When enabled, users can not fork projects from this group to external namespaces.
requestAccessEnabled Boolean: Boolean, is request for access enabled to the group.
runnersToken String: The group level registration token to use during runner setup.
visibilityLevel String: Visibility level of the group. Possible values are private, internal, public.
webUrl String: Web URL of the group.

Package Details

Repository: GitLab pulumi/pulumi-gitlab
License: Apache-2.0
Notes: This Pulumi package is based on the gitlab Terraform Provider.

gitlab.getGroup

Example Usage

Using getGroup

getGroup Result

Package Details

Contents