getTeam

suspend fun getTeam(argument: GetTeamPlainArgs): GetTeamResult

Use this data source to retrieve information about a GitHub team.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = github.getTeam({
slug: "example",
});
import pulumi
import pulumi_github as github
example = github.get_team(slug="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var example = Github.GetTeam.Invoke(new()
{
Slug = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-github/sdk/v6/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := github.LookupTeam(ctx, &github.LookupTeamArgs{
Slug: "example",
}, 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.github.GithubFunctions;
import com.pulumi.github.inputs.GetTeamArgs;
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 example = GithubFunctions.getTeam(GetTeamArgs.builder()
.slug("example")
.build());
}
}
variables:
example:
fn::invoke:
function: github:getTeam
arguments:
slug: example

Return

A collection of values returned by getTeam.

Parameters

argument

A collection of arguments for invoking getTeam.


suspend fun getTeam(membershipType: String? = null, resultsPerPage: Int? = null, slug: String, summaryOnly: Boolean? = null): GetTeamResult

Return

A collection of values returned by getTeam.

Parameters

membershipType

Type of membership to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"

resultsPerPage

Set the number of results per graphql query. Reducing this number can alleviate timeout errors. Accepts a value between 0 - 100. Defaults to 100.

slug

The team slug.

summaryOnly

Exclude the members and repositories of the team from the returned result. Defaults to false.

See also


suspend fun getTeam(argument: suspend GetTeamPlainArgsBuilder.() -> Unit): GetTeamResult

Return

A collection of values returned by getTeam.

Parameters

argument

Builder for com.pulumi.github.kotlin.inputs.GetTeamPlainArgs.

See also