gitlab logo
GitLab v4.9.0, Oct 24 22

gitlab.getGroupVariables

The gitlab.getGroupVariables data source allows to retrieve all group-level CI/CD variables.

Upstream API: GitLab REST API docs

Example Usage

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

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

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

});
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.GetGroupVariables(ctx, &GetGroupVariablesArgs{
			Group: "my/example/group",
		}, nil)
		if err != nil {
			return err
		}
		_, err = gitlab.GetGroupVariables(ctx, &GetGroupVariablesArgs{
			EnvironmentScope: pulumi.StringRef("staging/*"),
			Group:            "my/example/group",
		}, 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.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());

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

    }
}
import pulumi
import pulumi_gitlab as gitlab

vars = gitlab.get_group_variables(group="my/example/group")
staging_vars = gitlab.get_group_variables(environment_scope="staging/*",
    group="my/example/group")
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const vars = pulumi.output(gitlab.getGroupVariables({
    group: "my/example/group",
}));
// Using an environment scope
const stagingVars = pulumi.output(gitlab.getGroupVariables({
    environmentScope: "staging/*",
    group: "my/example/group",
}));
variables:
  vars:
    fn::invoke:
      Function: gitlab:getGroupVariables
      Arguments:
        group: my/example/group
  stagingVars:
    fn::invoke:
      Function: gitlab:getGroupVariables
      Arguments:
        environmentScope: staging/*
        group: my/example/group

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)
// Output-based functions aren't available in Java yet
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

EnvironmentScope string

The environment scope of the variable. Defaults to all environment (*).

Group string

The name or id of the group.

Key string
Masked bool
Protected bool
Value string
VariableType string
EnvironmentScope string

The environment scope of the variable. Defaults to all environment (*).

Group string

The name or id of the group.

Key string
Masked bool
Protected bool
Value string
VariableType string
environmentScope String

The environment scope of the variable. Defaults to all environment (*).

group String

The name or id of the group.

key String
masked Boolean
protected_ Boolean
value String
variableType String
environmentScope string

The environment scope of the variable. Defaults to all environment (*).

group string

The name or id of the group.

key string
masked boolean
protected boolean
value string
variableType string
environment_scope str

The environment scope of the variable. Defaults to all environment (*).

group str

The name or id of the group.

key str
masked bool
protected bool
value str
variable_type str
environmentScope String

The environment scope of the variable. Defaults to all environment (*).

group String

The name or id of the group.

key String
masked Boolean
protected Boolean
value String
variableType String

Package Details

Repository
GitLab pulumi/pulumi-gitlab
License
Apache-2.0
Notes

This Pulumi package is based on the gitlab Terraform Provider.