1. Packages
  2. GitHub
  3. API Docs
  4. getTeam
GitHub v6.2.2 published on Tuesday, Jun 18, 2024 by Pulumi

github.getTeam

Explore with Pulumi AI

github logo
GitHub v6.2.2 published on Tuesday, Jun 18, 2024 by Pulumi

    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")
    
    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
    	})
    }
    
    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 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
    

    Using getTeam

    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 getTeam(args: GetTeamArgs, opts?: InvokeOptions): Promise<GetTeamResult>
    function getTeamOutput(args: GetTeamOutputArgs, opts?: InvokeOptions): Output<GetTeamResult>
    def get_team(membership_type: Optional[str] = None,
                 results_per_page: Optional[int] = None,
                 slug: Optional[str] = None,
                 summary_only: Optional[bool] = None,
                 opts: Optional[InvokeOptions] = None) -> GetTeamResult
    def get_team_output(membership_type: Optional[pulumi.Input[str]] = None,
                 results_per_page: Optional[pulumi.Input[int]] = None,
                 slug: Optional[pulumi.Input[str]] = None,
                 summary_only: Optional[pulumi.Input[bool]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetTeamResult]
    func LookupTeam(ctx *Context, args *LookupTeamArgs, opts ...InvokeOption) (*LookupTeamResult, error)
    func LookupTeamOutput(ctx *Context, args *LookupTeamOutputArgs, opts ...InvokeOption) LookupTeamResultOutput

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

    public static class GetTeam 
    {
        public static Task<GetTeamResult> InvokeAsync(GetTeamArgs args, InvokeOptions? opts = null)
        public static Output<GetTeamResult> Invoke(GetTeamInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTeamResult> getTeam(GetTeamArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: github:index/getTeam:getTeam
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Slug string
    The team slug.
    MembershipType string
    Type of membership to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"
    ResultsPerPage int
    Set the number of results per graphql query. Reducing this number can alleviate timeout errors. Accepts a value between 0 - 100. Defaults to 100.
    SummaryOnly bool
    Exclude the members and repositories of the team from the returned result. Defaults to false.
    Slug string
    The team slug.
    MembershipType string
    Type of membership to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"
    ResultsPerPage int
    Set the number of results per graphql query. Reducing this number can alleviate timeout errors. Accepts a value between 0 - 100. Defaults to 100.
    SummaryOnly bool
    Exclude the members and repositories of the team from the returned result. Defaults to false.
    slug String
    The team slug.
    membershipType String
    Type of membership to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"
    resultsPerPage Integer
    Set the number of results per graphql query. Reducing this number can alleviate timeout errors. Accepts a value between 0 - 100. Defaults to 100.
    summaryOnly Boolean
    Exclude the members and repositories of the team from the returned result. Defaults to false.
    slug string
    The team slug.
    membershipType string
    Type of membership to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"
    resultsPerPage number
    Set the number of results per graphql query. Reducing this number can alleviate timeout errors. Accepts a value between 0 - 100. Defaults to 100.
    summaryOnly boolean
    Exclude the members and repositories of the team from the returned result. Defaults to false.
    slug str
    The team slug.
    membership_type str
    Type of membership to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"
    results_per_page int
    Set the number of results per graphql query. Reducing this number can alleviate timeout errors. Accepts a value between 0 - 100. Defaults to 100.
    summary_only bool
    Exclude the members and repositories of the team from the returned result. Defaults to false.
    slug String
    The team slug.
    membershipType String
    Type of membership to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"
    resultsPerPage Number
    Set the number of results per graphql query. Reducing this number can alleviate timeout errors. Accepts a value between 0 - 100. Defaults to 100.
    summaryOnly Boolean
    Exclude the members and repositories of the team from the returned result. Defaults to false.

    getTeam Result

    The following output properties are available:

    Description string
    the team's description.
    Id string
    The provider-assigned unique ID for this managed resource.
    Members List<string>
    List of team members (list of GitHub usernames). Not returned if summary_only = true
    Name string
    the team's full name.
    NodeId string
    the Node ID of the team.
    Permission string
    the team's permission level.
    Privacy string
    the team's privacy type.
    Repositories List<string>
    List of team repositories (list of repo names). Not returned if summary_only = true
    RepositoriesDetaileds List<GetTeamRepositoriesDetailed>
    List of team repositories (list of repo_id and role_name). Not returned if summary_only = true
    Slug string
    MembershipType string
    ResultsPerPage int
    SummaryOnly bool
    Description string
    the team's description.
    Id string
    The provider-assigned unique ID for this managed resource.
    Members []string
    List of team members (list of GitHub usernames). Not returned if summary_only = true
    Name string
    the team's full name.
    NodeId string
    the Node ID of the team.
    Permission string
    the team's permission level.
    Privacy string
    the team's privacy type.
    Repositories []string
    List of team repositories (list of repo names). Not returned if summary_only = true
    RepositoriesDetaileds []GetTeamRepositoriesDetailed
    List of team repositories (list of repo_id and role_name). Not returned if summary_only = true
    Slug string
    MembershipType string
    ResultsPerPage int
    SummaryOnly bool
    description String
    the team's description.
    id String
    The provider-assigned unique ID for this managed resource.
    members List<String>
    List of team members (list of GitHub usernames). Not returned if summary_only = true
    name String
    the team's full name.
    nodeId String
    the Node ID of the team.
    permission String
    the team's permission level.
    privacy String
    the team's privacy type.
    repositories List<String>
    List of team repositories (list of repo names). Not returned if summary_only = true
    repositoriesDetaileds List<GetTeamRepositoriesDetailed>
    List of team repositories (list of repo_id and role_name). Not returned if summary_only = true
    slug String
    membershipType String
    resultsPerPage Integer
    summaryOnly Boolean
    description string
    the team's description.
    id string
    The provider-assigned unique ID for this managed resource.
    members string[]
    List of team members (list of GitHub usernames). Not returned if summary_only = true
    name string
    the team's full name.
    nodeId string
    the Node ID of the team.
    permission string
    the team's permission level.
    privacy string
    the team's privacy type.
    repositories string[]
    List of team repositories (list of repo names). Not returned if summary_only = true
    repositoriesDetaileds GetTeamRepositoriesDetailed[]
    List of team repositories (list of repo_id and role_name). Not returned if summary_only = true
    slug string
    membershipType string
    resultsPerPage number
    summaryOnly boolean
    description str
    the team's description.
    id str
    The provider-assigned unique ID for this managed resource.
    members Sequence[str]
    List of team members (list of GitHub usernames). Not returned if summary_only = true
    name str
    the team's full name.
    node_id str
    the Node ID of the team.
    permission str
    the team's permission level.
    privacy str
    the team's privacy type.
    repositories Sequence[str]
    List of team repositories (list of repo names). Not returned if summary_only = true
    repositories_detaileds Sequence[GetTeamRepositoriesDetailed]
    List of team repositories (list of repo_id and role_name). Not returned if summary_only = true
    slug str
    membership_type str
    results_per_page int
    summary_only bool
    description String
    the team's description.
    id String
    The provider-assigned unique ID for this managed resource.
    members List<String>
    List of team members (list of GitHub usernames). Not returned if summary_only = true
    name String
    the team's full name.
    nodeId String
    the Node ID of the team.
    permission String
    the team's permission level.
    privacy String
    the team's privacy type.
    repositories List<String>
    List of team repositories (list of repo names). Not returned if summary_only = true
    repositoriesDetaileds List<Property Map>
    List of team repositories (list of repo_id and role_name). Not returned if summary_only = true
    slug String
    membershipType String
    resultsPerPage Number
    summaryOnly Boolean

    Supporting Types

    GetTeamRepositoriesDetailed

    RepoId int
    RoleName string
    RepoId int
    RoleName string
    repoId Integer
    roleName String
    repoId number
    roleName string
    repoId Number
    roleName String

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.2.2 published on Tuesday, Jun 18, 2024 by Pulumi