Class 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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Team

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Github

Assembly: Pulumi.Github.dll

Syntax

public class Team : CustomResource

Constructors

Team(String, TeamArgs, CustomResourceOptions)

Create a Team resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
TeamArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Description

A description of the team.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Etag

Declaration

public Output<string> Etag { get; }

Property Value

Type	Description
Output<System.String>

LdapDn

The LDAP Distinguished Name of the group where membership will be synchronized. Only available in GitHub Enterprise.

Declaration

public Output<string> LdapDn { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the team.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NodeId

Declaration

public Output<string> NodeId { get; }

Property Value

Type	Description
Output<System.String>

ParentTeamId

The ID of the parent team, if this is a nested team.

Declaration

public Output<int?> ParentTeamId { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Privacy

The level of privacy for the team. Must be one of secret or closed. Defaults to secret.

Declaration

public Output<string> Privacy { get; }

Property Value

Type	Description
Output<System.String>

Slug

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.

Declaration

public Output<string> Slug { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, TeamState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
TeamState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Team