gitlab.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 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:
getGroup Result
The following output properties are available:
- Default
Branch intProtection Whether developers and maintainers can push to the applicable default branch.
- Description string
The description of the group.
- Full
Name string The full name of the group.
- Full
Path string The full path of the group.
- Group
Id int The ID of the group.
- Id string
The provider-assigned unique ID for this managed resource.
- Lfs
Enabled bool Boolean, is LFS enabled for projects in this group.
- Name string
The name of this group.
- Parent
Id int Integer, ID of the parent group.
- Path string
The path of the group.
- Prevent
Forking boolOutside Group When enabled, users can not fork projects from this group to external namespaces.
- Request
Access boolEnabled Boolean, is request for access enabled to the group.
- Runners
Token string The group level registration token to use during runner setup.
- Visibility
Level string Visibility level of the group. Possible values are
private
,internal
,public
.- Web
Url string Web URL of the group.
- Default
Branch intProtection Whether developers and maintainers can push to the applicable default branch.
- Description string
The description of the group.
- Full
Name string The full name of the group.
- Full
Path string The full path of the group.
- Group
Id int The ID of the group.
- Id string
The provider-assigned unique ID for this managed resource.
- Lfs
Enabled bool Boolean, is LFS enabled for projects in this group.
- Name string
The name of this group.
- Parent
Id int Integer, ID of the parent group.
- Path string
The path of the group.
- Prevent
Forking boolOutside Group When enabled, users can not fork projects from this group to external namespaces.
- Request
Access boolEnabled Boolean, is request for access enabled to the group.
- Runners
Token string The group level registration token to use during runner setup.
- Visibility
Level string Visibility level of the group. Possible values are
private
,internal
,public
.- Web
Url string Web URL of the group.
- default
Branch IntegerProtection Whether developers and maintainers can push to the applicable default branch.
- description String
The description of the group.
- full
Name String The full name of the group.
- full
Path String The full path of the group.
- group
Id Integer The ID of the group.
- id String
The provider-assigned unique ID for this managed resource.
- lfs
Enabled Boolean Boolean, is LFS enabled for projects in this group.
- name String
The name of this group.
- parent
Id Integer Integer, ID of the parent group.
- path String
The path of the group.
- prevent
Forking BooleanOutside Group When enabled, users can not fork projects from this group to external namespaces.
- request
Access BooleanEnabled Boolean, is request for access enabled to the group.
- runners
Token String The group level registration token to use during runner setup.
- visibility
Level String Visibility level of the group. Possible values are
private
,internal
,public
.- web
Url String Web URL of the group.
- default
Branch numberProtection Whether developers and maintainers can push to the applicable default branch.
- description string
The description of the group.
- full
Name string The full name of the group.
- full
Path string The full path of the group.
- group
Id number The ID of the group.
- id string
The provider-assigned unique ID for this managed resource.
- lfs
Enabled boolean Boolean, is LFS enabled for projects in this group.
- name string
The name of this group.
- parent
Id number Integer, ID of the parent group.
- path string
The path of the group.
- prevent
Forking booleanOutside Group When enabled, users can not fork projects from this group to external namespaces.
- request
Access booleanEnabled Boolean, is request for access enabled to the group.
- runners
Token string The group level registration token to use during runner setup.
- visibility
Level string Visibility level of the group. Possible values are
private
,internal
,public
.- web
Url string Web URL of the group.
- default_
branch_ intprotection 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_ booloutside_ group When enabled, users can not fork projects from this group to external namespaces.
- request_
access_ boolenabled 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.
- default
Branch NumberProtection Whether developers and maintainers can push to the applicable default branch.
- description String
The description of the group.
- full
Name String The full name of the group.
- full
Path String The full path of the group.
- group
Id Number The ID of the group.
- id String
The provider-assigned unique ID for this managed resource.
- lfs
Enabled Boolean Boolean, is LFS enabled for projects in this group.
- name String
The name of this group.
- parent
Id Number Integer, ID of the parent group.
- path String
The path of the group.
- prevent
Forking BooleanOutside Group When enabled, users can not fork projects from this group to external namespaces.
- request
Access BooleanEnabled Boolean, is request for access enabled to the group.
- runners
Token String The group level registration token to use during runner setup.
- visibility
Level String Visibility level of the group. Possible values are
private
,internal
,public
.- web
Url 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.