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 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:
getGroup Result
The following output properties are available:
- Default
Branch intProtection - Description string
- Full
Name string - Full
Path string - Group
Id int - Id string
The provider-assigned unique ID for this managed resource.
- Lfs
Enabled bool - Name string
- Parent
Id int - Path string
- Prevent
Forking boolOutside Group - Request
Access boolEnabled - Runners
Token string - Visibility
Level string - Web
Url string
- Default
Branch intProtection - Description string
- Full
Name string - Full
Path string - Group
Id int - Id string
The provider-assigned unique ID for this managed resource.
- Lfs
Enabled bool - Name string
- Parent
Id int - Path string
- Prevent
Forking boolOutside Group - Request
Access boolEnabled - Runners
Token string - Visibility
Level string - Web
Url string
- default
Branch IntegerProtection - description String
- full
Name String - full
Path String - group
Id Integer - id String
The provider-assigned unique ID for this managed resource.
- lfs
Enabled Boolean - name String
- parent
Id Integer - path String
- prevent
Forking BooleanOutside Group - request
Access BooleanEnabled - runners
Token String - visibility
Level String - web
Url String
- default
Branch numberProtection - description string
- full
Name string - full
Path string - group
Id number - id string
The provider-assigned unique ID for this managed resource.
- lfs
Enabled boolean - name string
- parent
Id number - path string
- prevent
Forking booleanOutside Group - request
Access booleanEnabled - runners
Token string - visibility
Level string - web
Url string
- default_
branch_ intprotection - 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_ booloutside_ group - request_
access_ boolenabled - runners_
token str - visibility_
level str - web_
url str
- default
Branch NumberProtection - description String
- full
Name String - full
Path String - group
Id Number - id String
The provider-assigned unique ID for this managed resource.
- lfs
Enabled Boolean - name String
- parent
Id Number - path String
- prevent
Forking BooleanOutside Group - request
Access BooleanEnabled - runners
Token String - visibility
Level String - web
Url 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.