GitLab

Pulumi Official
Package maintained by Pulumi
v4.7.1 published on Thursday, Jun 30, 2022 by Pulumi

getGroup

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

Upstream API: GitLab REST API docs

Example Usage

using Pulumi;
using GitLab = Pulumi.GitLab;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(GitLab.GetGroup.InvokeAsync(new GitLab.GetGroupArgs
        {
            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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var foo = Output.of(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
GroupId int
FullPath string
GroupId int
fullPath String
groupId Integer
fullPath string
groupId number
fullPath String
groupId Number

getGroup Result

The following output properties are available:

DefaultBranchProtection int
Description string
FullName string
FullPath string
GroupId int
Id string

The provider-assigned unique ID for this managed resource.

LfsEnabled bool
Name string
ParentId int
Path string
PreventForkingOutsideGroup bool
RequestAccessEnabled bool
RunnersToken string
VisibilityLevel string
WebUrl string
DefaultBranchProtection int
Description string
FullName string
FullPath string
GroupId int
Id string

The provider-assigned unique ID for this managed resource.

LfsEnabled bool
Name string
ParentId int
Path string
PreventForkingOutsideGroup bool
RequestAccessEnabled bool
RunnersToken string
VisibilityLevel string
WebUrl string
defaultBranchProtection Integer
description String
fullName String
fullPath String
groupId Integer
id String

The provider-assigned unique ID for this managed resource.

lfsEnabled Boolean
name String
parentId Integer
path String
preventForkingOutsideGroup Boolean
requestAccessEnabled Boolean
runnersToken String
visibilityLevel String
webUrl String
defaultBranchProtection number
description string
fullName string
fullPath string
groupId number
id string

The provider-assigned unique ID for this managed resource.

lfsEnabled boolean
name string
parentId number
path string
preventForkingOutsideGroup boolean
requestAccessEnabled boolean
runnersToken string
visibilityLevel string
webUrl string
default_branch_protection int
description str
full_name str
full_path str
group_id int
id str

The provider-assigned unique ID for this managed resource.

lfs_enabled bool
name str
parent_id int
path str
prevent_forking_outside_group bool
request_access_enabled bool
runners_token str
visibility_level str
web_url str
defaultBranchProtection Number
description String
fullName String
fullPath String
groupId Number
id String

The provider-assigned unique ID for this managed resource.

lfsEnabled Boolean
name String
parentId Number
path String
preventForkingOutsideGroup Boolean
requestAccessEnabled Boolean
runnersToken String
visibilityLevel String
webUrl String

Package Details

Repository
https://github.com/pulumi/pulumi-gitlab
License
Apache-2.0
Notes

This Pulumi package is based on the gitlab Terraform Provider.