Class TeamRepository

This resource manages relationships between teams and repositories in your GitHub organization.

Creating this resource grants a particular team permissions on a particular repository.

The repository and the team must both belong to the same organization on GitHub. This resource does not actually create any repositories; to do that, see github..Repository.

Example Usage

using Pulumi;
using Github = Pulumi.Github;

class MyStack : Stack
{
public MyStack()
{
    // Add a repository to the team
    var someTeam = new Github.Team("someTeam", new Github.TeamArgs
    {
        Description = "Some cool team",
    });
    var someRepo = new Github.Repository("someRepo", new Github.RepositoryArgs
    {
    });
    var someTeamRepo = new Github.TeamRepository("someTeamRepo", new Github.TeamRepositoryArgs
    {
        Permission = "pull",
        Repository = someRepo.Name,
        TeamId = someTeam.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

TeamRepository

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 TeamRepository : CustomResource

Constructors

TeamRepository(String, TeamRepositoryArgs, CustomResourceOptions)

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

Declaration

public TeamRepository(string name, TeamRepositoryArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

Etag

Declaration

public Output<string> Etag { get; }

Property Value

Type	Description
Output<System.String>

Permission

The permissions of team members regarding the repository. Must be one of pull, triage, push, maintain, or admin. Defaults to pull.

Declaration

public Output<string> Permission { get; }

Property Value

Type	Description
Output<System.String>

Repository

The repository to add to the team.

Declaration

public Output<string> Repository { get; }

Property Value

Type	Description
Output<System.String>

TeamId

The GitHub team id

Declaration

public Output<string> TeamId { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static TeamRepository Get(string name, Input<string> id, TeamRepositoryState 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.
TeamRepositoryState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
TeamRepository