gitlab.getGroupVariables (v7)

GitLab v7.0.0 (7.x), Mar 9 26

Viewing docs for GitLab v7.0.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-gitlab

Viewing docs for GitLab v7.0.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-gitlab

Example Usage

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

const vars = gitlab.getGroupVariables({
    group: "my/example/group",
});
// Using an environment scope
const stagingVars = gitlab.getGroupVariables({
    group: "my/example/group",
    environmentScope: "staging/*",
});

import pulumi
import pulumi_gitlab as gitlab

vars = gitlab.get_group_variables(group="my/example/group")
# Using an environment scope
staging_vars = gitlab.get_group_variables(group="my/example/group",
    environment_scope="staging/*")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.GetGroupVariables(ctx, &gitlab.GetGroupVariablesArgs{
			Group: "my/example/group",
		}, nil)
		if err != nil {
			return err
		}
		// Using an environment scope
		_, err = gitlab.GetGroupVariables(ctx, &gitlab.GetGroupVariablesArgs{
			Group:            "my/example/group",
			EnvironmentScope: pulumi.StringRef("staging/*"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var vars = GitLab.GetGroupVariables.Invoke(new()
    {
        Group = "my/example/group",
    });

    // Using an environment scope
    var stagingVars = GitLab.GetGroupVariables.Invoke(new()
    {
        Group = "my/example/group",
        EnvironmentScope = "staging/*",
    });

});

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.GetGroupVariablesArgs;
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 vars = GitlabFunctions.getGroupVariables(GetGroupVariablesArgs.builder()
            .group("my/example/group")
            .build());

        // Using an environment scope
        final var stagingVars = GitlabFunctions.getGroupVariables(GetGroupVariablesArgs.builder()
            .group("my/example/group")
            .environmentScope("staging/*")
            .build());

    }
}

variables:
  vars:
    fn::invoke:
      Function: gitlab:getGroupVariables
      Arguments:
        group: my/example/group
  # Using an environment scope
  stagingVars:
    fn::invoke:
      Function: gitlab:getGroupVariables
      Arguments:
        group: my/example/group
        environmentScope: staging/*

Using getGroupVariables

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 getGroupVariables(args: GetGroupVariablesArgs, opts?: InvokeOptions): Promise<GetGroupVariablesResult>
function getGroupVariablesOutput(args: GetGroupVariablesOutputArgs, opts?: InvokeOptions): Output<GetGroupVariablesResult>

def get_group_variables(environment_scope: Optional[str] = None,
                        group: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetGroupVariablesResult
def get_group_variables_output(environment_scope: Optional[pulumi.Input[str]] = None,
                        group: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetGroupVariablesResult]

func GetGroupVariables(ctx *Context, args *GetGroupVariablesArgs, opts ...InvokeOption) (*GetGroupVariablesResult, error)
func GetGroupVariablesOutput(ctx *Context, args *GetGroupVariablesOutputArgs, opts ...InvokeOption) GetGroupVariablesResultOutput

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

public static class GetGroupVariables 
{
    public static Task<GetGroupVariablesResult> InvokeAsync(GetGroupVariablesArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupVariablesResult> Invoke(GetGroupVariablesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGroupVariablesResult> getGroupVariables(GetGroupVariablesArgs args, InvokeOptions options)
public static Output<GetGroupVariablesResult> getGroupVariables(GetGroupVariablesArgs args, InvokeOptions options)

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

The following arguments are supported:

Group string: The name or id of the group.
EnvironmentScope string: The environment scope of the variable. Defaults to all environment (*).

Group string: The name or id of the group.
EnvironmentScope string: The environment scope of the variable. Defaults to all environment (*).

group String: The name or id of the group.
environmentScope String: The environment scope of the variable. Defaults to all environment (*).

group string: The name or id of the group.
environmentScope string: The environment scope of the variable. Defaults to all environment (*).

group str: The name or id of the group.
environment_scope str: The environment scope of the variable. Defaults to all environment (*).

group String: The name or id of the group.
environmentScope String: The environment scope of the variable. Defaults to all environment (*).

getGroupVariables Result

The following output properties are available:

Group string: The name or id of the group.
Id string: The provider-assigned unique ID for this managed resource.
Variables List<Pulumi.GitLab.Outputs.GetGroupVariablesVariable>: The list of variables returned by the search
EnvironmentScope string: The environment scope of the variable. Defaults to all environment (*).

Group string: The name or id of the group.
Id string: The provider-assigned unique ID for this managed resource.
Variables []GetGroupVariablesVariable: The list of variables returned by the search
EnvironmentScope string: The environment scope of the variable. Defaults to all environment (*).

group String: The name or id of the group.
id String: The provider-assigned unique ID for this managed resource.
variables List<GetGroupVariablesVariable>: The list of variables returned by the search
environmentScope String: The environment scope of the variable. Defaults to all environment (*).

group string: The name or id of the group.
id string: The provider-assigned unique ID for this managed resource.
variables GetGroupVariablesVariable[]: The list of variables returned by the search
environmentScope string: The environment scope of the variable. Defaults to all environment (*).

group str: The name or id of the group.
id str: The provider-assigned unique ID for this managed resource.
variables Sequence[GetGroupVariablesVariable]: The list of variables returned by the search
environment_scope str: The environment scope of the variable. Defaults to all environment (*).

group String: The name or id of the group.
id String: The provider-assigned unique ID for this managed resource.
variables List<Property Map>: The list of variables returned by the search
environmentScope String: The environment scope of the variable. Defaults to all environment (*).

Supporting Types

GetGroupVariablesVariable

Description string: The description of the variable.
EnvironmentScope string: The environment scope of the variable. Defaults to all environment (*). Note that in Community Editions of Gitlab, values other than * will cause inconsistent plans.
Group string: The name or id of the group.
Key string: The name of the variable.
Masked bool: If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
Protected bool: If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
Raw bool: Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
Value string: The value of the variable.
VariableType string: The type of a variable. Valid values are: env_var, file. Default is env_var.

Description string: The description of the variable.
EnvironmentScope string: The environment scope of the variable. Defaults to all environment (*). Note that in Community Editions of Gitlab, values other than * will cause inconsistent plans.
Group string: The name or id of the group.
Key string: The name of the variable.
Masked bool: If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
Protected bool: If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
Raw bool: Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
Value string: The value of the variable.
VariableType string: The type of a variable. Valid values are: env_var, file. Default is env_var.

description String: The description of the variable.
environmentScope String: The environment scope of the variable. Defaults to all environment (*). Note that in Community Editions of Gitlab, values other than * will cause inconsistent plans.
group String: The name or id of the group.
key String: The name of the variable.
masked Boolean: If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
protected_ Boolean: If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
raw Boolean: Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
value String: The value of the variable.
variableType String: The type of a variable. Valid values are: env_var, file. Default is env_var.

description string: The description of the variable.
environmentScope string: The environment scope of the variable. Defaults to all environment (*). Note that in Community Editions of Gitlab, values other than * will cause inconsistent plans.
group string: The name or id of the group.
key string: The name of the variable.
masked boolean: If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
protected boolean: If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
raw boolean: Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
value string: The value of the variable.
variableType string: The type of a variable. Valid values are: env_var, file. Default is env_var.

description str: The description of the variable.
environment_scope str: The environment scope of the variable. Defaults to all environment (*). Note that in Community Editions of Gitlab, values other than * will cause inconsistent plans.
group str: The name or id of the group.
key str: The name of the variable.
masked bool: If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
protected bool: If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
raw bool: Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
value str: The value of the variable.
variable_type str: The type of a variable. Valid values are: env_var, file. Default is env_var.

description String: The description of the variable.
environmentScope String: The environment scope of the variable. Defaults to all environment (*). Note that in Community Editions of Gitlab, values other than * will cause inconsistent plans.
group String: The name or id of the group.
key String: The name of the variable.
masked Boolean: If set to true, the value of the variable will be hidden in job logs. The value must meet the masking requirements. Defaults to false.
protected Boolean: If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
raw Boolean: Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
value String: The value of the variable.
variableType String: The type of a variable. Valid values are: env_var, file. Default is env_var.