Team

Provides a GitHub team resource.

This resource allows you to add/remove teams from your organization. When applied, a new team will be created. When destroyed, that team will be removed.

Example Usage

using Pulumi;
using Github = Pulumi.Github;

class MyStack : Stack
{
    public MyStack()
    {
        // Add a team to the organization
        var someTeam = new Github.Team("someTeam", new Github.TeamArgs
        {
            Description = "Some cool team",
            Privacy = "closed",
        });
    }

}

Coming soon!

import pulumi
import pulumi_github as github

# Add a team to the organization
some_team = github.Team("someTeam",
    description="Some cool team",
    privacy="closed")

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

// Add a team to the organization
const someTeam = new github.Team("some_team", {
    description: "Some cool team",
    privacy: "closed",
});

Create a Team Resource

new Team(name: string, args?: TeamArgs, opts?: CustomResourceOptions);

def Team(resource_name, opts=None, description=None, ldap_dn=None, name=None, parent_team_id=None, privacy=None, __props__=None);

func NewTeam(ctx *Context, name string, args *TeamArgs, opts ...ResourceOption) (*Team, error)

public Team(string name, TeamArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args TeamArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TeamArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TeamArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Team Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Team resource accepts the following input properties:

Description string: A description of the team.
LdapDn string: The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise.
Name string: The name of the team.
ParentTeamId int: The ID of the parent team, if this is a nested team.
Privacy string: The level of privacy for the team. Must be one of secret or closed. Defaults to secret.

Description string: A description of the team.
LdapDn string: The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise.
Name string: The name of the team.
ParentTeamId int: The ID of the parent team, if this is a nested team.
Privacy string: The level of privacy for the team. Must be one of secret or closed. Defaults to secret.

description string: A description of the team.
ldapDn string: The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise.
name string: The name of the team.
parentTeamId number: The ID of the parent team, if this is a nested team.
privacy string: The level of privacy for the team. Must be one of secret or closed. Defaults to secret.

description str: A description of the team.
ldap_dn str: The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise.
name str: The name of the team.
parent_team_id float: The ID of the parent team, if this is a nested team.
privacy str: The level of privacy for the team. Must be one of secret or closed. Defaults to secret.

Outputs

All input properties are implicitly available as output properties. Additionally, the Team resource produces the following output properties:

Etag string
Id string: The provider-assigned unique ID for this managed resource.
NodeId string
Slug string: The slug of the created team, which may or may not differ from name, depending on whether name contains “URL-unsafe” characters. Useful when referencing the team in github..BranchProtection.

Etag string
Id string: The provider-assigned unique ID for this managed resource.
NodeId string
Slug string: The slug of the created team, which may or may not differ from name, depending on whether name contains “URL-unsafe” characters. Useful when referencing the team in github..BranchProtection.

etag string
id string: The provider-assigned unique ID for this managed resource.
nodeId string
slug string: The slug of the created team, which may or may not differ from name, depending on whether name contains “URL-unsafe” characters. Useful when referencing the team in github..BranchProtection.

etag str
id str: The provider-assigned unique ID for this managed resource.
node_id str
slug str: The slug of the created team, which may or may not differ from name, depending on whether name contains “URL-unsafe” characters. Useful when referencing the team in github..BranchProtection.

Look up an Existing Team Resource

Get an existing Team resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TeamState, opts?: CustomResourceOptions): Team

static get(resource_name, id, opts=None, description=None, etag=None, ldap_dn=None, name=None, node_id=None, parent_team_id=None, privacy=None, slug=None, __props__=None);

func GetTeam(ctx *Context, name string, id IDInput, state *TeamState, opts ...ResourceOption) (*Team, error)

public static Team Get(string name, Input<string> id, TeamState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Description string: A description of the team.
Etag string
LdapDn string: The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise.
Name string: The name of the team.
NodeId string
ParentTeamId int: The ID of the parent team, if this is a nested team.
Privacy string: The level of privacy for the team. Must be one of secret or closed. Defaults to secret.
Slug string: The slug of the created team, which may or may not differ from name, depending on whether name contains “URL-unsafe” characters. Useful when referencing the team in github..BranchProtection.

Description string: A description of the team.
Etag string
LdapDn string: The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise.
Name string: The name of the team.
NodeId string
ParentTeamId int: The ID of the parent team, if this is a nested team.
Privacy string: The level of privacy for the team. Must be one of secret or closed. Defaults to secret.
Slug string: The slug of the created team, which may or may not differ from name, depending on whether name contains “URL-unsafe” characters. Useful when referencing the team in github..BranchProtection.

description string: A description of the team.
etag string
ldapDn string: The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise.
name string: The name of the team.
nodeId string
parentTeamId number: The ID of the parent team, if this is a nested team.
privacy string: The level of privacy for the team. Must be one of secret or closed. Defaults to secret.
slug string: The slug of the created team, which may or may not differ from name, depending on whether name contains “URL-unsafe” characters. Useful when referencing the team in github..BranchProtection.

description str: A description of the team.
etag str
ldap_dn str: The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise.
name str: The name of the team.
node_id str
parent_team_id float: The ID of the parent team, if this is a nested team.
privacy str: The level of privacy for the team. Must be one of secret or closed. Defaults to secret.
slug str: The slug of the created team, which may or may not differ from name, depending on whether name contains “URL-unsafe” characters. Useful when referencing the team in github..BranchProtection.

Package Details

Repository: https://github.com/pulumi/pulumi-github
License: Apache-2.0
Notes: This Pulumi package is based on the github Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud