pulumi-github-kotlin/com.pulumi.github.kotlin/GithubFunctions/getOrganizationTeams

getOrganizationTeams

suspend fun getOrganizationTeams(argument: GetOrganizationTeamsPlainArgs): GetOrganizationTeamsResult

Use this data source to retrieve information about all GitHub teams in an organization.

Example Usage

To retrieve all teams of the organization:

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const all = github.getOrganizationTeams({});
Content copied to clipboard
import pulumi
import pulumi_github as github
all = github.get_organization_teams()
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
    var all = Github.GetOrganizationTeams.Invoke();
});
Content copied to clipboard
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.GetOrganizationTeams(ctx, &github.GetOrganizationTeamsArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.GetOrganizationTeamsArgs;
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 all = GithubFunctions.getOrganizationTeams();
    }
}
Content copied to clipboard
variables:
  all:
    fn::invoke:
      function: github:getOrganizationTeams
      arguments: {}
Content copied to clipboard

To retrieve only the team's at the root of the organization:

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const rootTeams = github.getOrganizationTeams({
    rootTeamsOnly: true,
});
Content copied to clipboard
import pulumi
import pulumi_github as github
root_teams = github.get_organization_teams(root_teams_only=True)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
    var rootTeams = Github.GetOrganizationTeams.Invoke(new()
    {
        RootTeamsOnly = true,
    });
});
Content copied to clipboard
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.GetOrganizationTeams(ctx, &github.GetOrganizationTeamsArgs{
			RootTeamsOnly: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.GetOrganizationTeamsArgs;
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 rootTeams = GithubFunctions.getOrganizationTeams(GetOrganizationTeamsArgs.builder()
            .rootTeamsOnly(true)
            .build());
    }
}
Content copied to clipboard
variables:
  rootTeams:
    fn::invoke:
      function: github:getOrganizationTeams
      arguments:
        rootTeamsOnly: true
Content copied to clipboard

Return

A collection of values returned by getOrganizationTeams.

Parameters

argument

A collection of arguments for invoking getOrganizationTeams.

suspend fun getOrganizationTeams(resultsPerPage: Int? = null, rootTeamsOnly: Boolean? = null, summaryOnly: Boolean? = null): GetOrganizationTeamsResult

Return

A collection of values returned by getOrganizationTeams.

Parameters

resultsPerPage

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

rootTeamsOnly

(Optional) Only return teams that are at the organization's root, i.e. no nested teams. Defaults to false.

summaryOnly

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

See also

.

suspend fun getOrganizationTeams(argument: suspend GetOrganizationTeamsPlainArgsBuilder.() -> Unit): GetOrganizationTeamsResult

Return

A collection of values returned by getOrganizationTeams.

Parameters

argument

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

See also

.