getClusterAgents

GitLab v9.10.0, Mar 9 26

Viewing docs for GitLab v9.10.0
published on Monday, Mar 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gitlab

Viewing docs for GitLab v9.10.0
published on Monday, Mar 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gitlab

Example Usage

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

const agents = gitlab.getClusterAgents({
    project: "12345",
});

import pulumi
import pulumi_gitlab as gitlab

agents = gitlab.get_cluster_agents(project="12345")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.GetClusterAgents(ctx, &gitlab.GetClusterAgentsArgs{
			Project: "12345",
		}, 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 agents = GitLab.GetClusterAgents.Invoke(new()
    {
        Project = "12345",
    });

});

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.GetClusterAgentsArgs;
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 agents = GitlabFunctions.getClusterAgents(GetClusterAgentsArgs.builder()
            .project("12345")
            .build());

    }
}

variables:
  agents:
    fn::invoke:
      function: gitlab:getClusterAgents
      arguments:
        project: '12345'

Using getClusterAgents

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 getClusterAgents(args: GetClusterAgentsArgs, opts?: InvokeOptions): Promise<GetClusterAgentsResult>
function getClusterAgentsOutput(args: GetClusterAgentsOutputArgs, opts?: InvokeOptions): Output<GetClusterAgentsResult>

def get_cluster_agents(project: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetClusterAgentsResult
def get_cluster_agents_output(project: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetClusterAgentsResult]

func GetClusterAgents(ctx *Context, args *GetClusterAgentsArgs, opts ...InvokeOption) (*GetClusterAgentsResult, error)
func GetClusterAgentsOutput(ctx *Context, args *GetClusterAgentsOutputArgs, opts ...InvokeOption) GetClusterAgentsResultOutput

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

public static class GetClusterAgents 
{
    public static Task<GetClusterAgentsResult> InvokeAsync(GetClusterAgentsArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterAgentsResult> Invoke(GetClusterAgentsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClusterAgentsResult> getClusterAgents(GetClusterAgentsArgs args, InvokeOptions options)
public static Output<GetClusterAgentsResult> getClusterAgents(GetClusterAgentsArgs args, InvokeOptions options)

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

The following arguments are supported:

Project string: ID or full path of the project maintained by the authenticated user.

Project string: ID or full path of the project maintained by the authenticated user.

project String: ID or full path of the project maintained by the authenticated user.

project string: ID or full path of the project maintained by the authenticated user.

project str: ID or full path of the project maintained by the authenticated user.

project String: ID or full path of the project maintained by the authenticated user.