Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azuredevops Provider
  3. API Docs
  4. Team
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.Team

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-azuredevops

    Manages a team within a project in a Azure DevOps organization.

    Example Usage

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

const example = new azuredevops.Project("example", {
    name: "Example Project",
    workItemTemplate: "Agile",
    versionControl: "Git",
    visibility: "private",
    description: "Managed by Terraform",
});
const example-project-contributors = azuredevops.getGroupOutput({
    projectId: example.id,
    name: "Contributors",
});
const example-project-readers = azuredevops.getGroupOutput({
    projectId: example.id,
    name: "Readers",
});
const exampleTeam = new azuredevops.Team("example", {
    projectId: example.id,
    name: "Example Team",
    administrators: [example_project_contributors.apply(example_project_contributors => example_project_contributors.descriptor)],
    members: [example_project_readers.apply(example_project_readers => example_project_readers.descriptor)],
});

    import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example",
    name="Example Project",
    work_item_template="Agile",
    version_control="Git",
    visibility="private",
    description="Managed by Terraform")
example_project_contributors = azuredevops.get_group_output(project_id=example.id,
    name="Contributors")
example_project_readers = azuredevops.get_group_output(project_id=example.id,
    name="Readers")
example_team = azuredevops.Team("example",
    project_id=example.id,
    name="Example Team",
    administrators=[example_project_contributors.descriptor],
    members=[example_project_readers.descriptor])

    package main

import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuredevops.NewProject(ctx, "example", &azuredevops.ProjectArgs{
			Name:             pulumi.String("Example Project"),
			WorkItemTemplate: pulumi.String("Agile"),
			VersionControl:   pulumi.String("Git"),
			Visibility:       pulumi.String("private"),
			Description:      pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		example_project_contributors := azuredevops.LookupGroupOutput(ctx, azuredevops.GetGroupOutputArgs{
			ProjectId: example.ID(),
			Name:      pulumi.String("Contributors"),
		}, nil)
		example_project_readers := azuredevops.LookupGroupOutput(ctx, azuredevops.GetGroupOutputArgs{
			ProjectId: example.ID(),
			Name:      pulumi.String("Readers"),
		}, nil)
		_, err = azuredevops.NewTeam(ctx, "example", &azuredevops.TeamArgs{
			ProjectId: example.ID(),
			Name:      pulumi.String("Example Team"),
			Administrators: pulumi.StringArray{
				pulumi.String(example_project_contributors.ApplyT(func(example_project_contributors azuredevops.GetGroupResult) (*string, error) {
					return &example_project_contributors.Descriptor, nil
				}).(pulumi.StringPtrOutput)),
			},
			Members: pulumi.StringArray{
				pulumi.String(example_project_readers.ApplyT(func(example_project_readers azuredevops.GetGroupResult) (*string, error) {
					return &example_project_readers.Descriptor, nil
				}).(pulumi.StringPtrOutput)),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var example = new AzureDevOps.Project("example", new()
    {
        Name = "Example Project",
        WorkItemTemplate = "Agile",
        VersionControl = "Git",
        Visibility = "private",
        Description = "Managed by Terraform",
    });

    var example_project_contributors = AzureDevOps.GetGroup.Invoke(new()
    {
        ProjectId = example.Id,
        Name = "Contributors",
    });

    var example_project_readers = AzureDevOps.GetGroup.Invoke(new()
    {
        ProjectId = example.Id,
        Name = "Readers",
    });

    var exampleTeam = new AzureDevOps.Team("example", new()
    {
        ProjectId = example.Id,
        Name = "Example Team",
        Administrators = new[]
        {
            example_project_contributors.Apply(example_project_contributors => example_project_contributors.Apply(getGroupResult => getGroupResult.Descriptor)),
        },
        Members = new[]
        {
            example_project_readers.Apply(example_project_readers => example_project_readers.Apply(getGroupResult => getGroupResult.Descriptor)),
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.AzuredevopsFunctions;
import com.pulumi.azuredevops.inputs.GetGroupArgs;
import com.pulumi.azuredevops.Team;
import com.pulumi.azuredevops.TeamArgs;
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) {
        var example = new Project("example", ProjectArgs.builder()
            .name("Example Project")
            .workItemTemplate("Agile")
            .versionControl("Git")
            .visibility("private")
            .description("Managed by Terraform")
            .build());

        final var example-project-contributors = AzuredevopsFunctions.getGroup(GetGroupArgs.builder()
            .projectId(example.id())
            .name("Contributors")
            .build());

        final var example-project-readers = AzuredevopsFunctions.getGroup(GetGroupArgs.builder()
            .projectId(example.id())
            .name("Readers")
            .build());

        var exampleTeam = new Team("exampleTeam", TeamArgs.builder()
            .projectId(example.id())
            .name("Example Team")
            .administrators(example_project_contributors.applyValue(example_project_contributors -> example_project_contributors.descriptor()))
            .members(example_project_readers.applyValue(example_project_readers -> example_project_readers.descriptor()))
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      workItemTemplate: Agile
      versionControl: Git
      visibility: private
      description: Managed by Terraform
  exampleTeam:
    type: azuredevops:Team
    name: example
    properties:
      projectId: ${example.id}
      name: Example Team
      administrators:
        - ${["example-project-contributors"].descriptor}
      members:
        - ${["example-project-readers"].descriptor}
variables:
  example-project-contributors:
    fn::invoke:
      Function: azuredevops:getGroup
      Arguments:
        projectId: ${example.id}
        name: Contributors
  example-project-readers:
    fn::invoke:
      Function: azuredevops:getGroup
      Arguments:
        projectId: ${example.id}
        name: Readers

    PAT Permissions Required

    • vso.project_manage: Grants the ability to create, read, update, and delete projects and teams.

    Create Team Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Team(name: string, args: TeamArgs, opts?: CustomResourceOptions);
    @overload
def Team(resource_name: str,
         args: TeamArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Team(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         project_id: Optional[str] = None,
         administrators: Optional[Sequence[str]] = None,
         description: Optional[str] = None,
         members: Optional[Sequence[str]] = None,
         name: Optional[str] = None)
    func NewTeam(ctx *Context, name string, args TeamArgs, opts ...ResourceOption) (*Team, error)
    public Team(string name, TeamArgs args, CustomResourceOptions? opts = null)
    public Team(String name, TeamArgs args)
public Team(String name, TeamArgs args, CustomResourceOptions options)

    type: azuredevops:Team
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args TeamArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args TeamArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var teamResource = new AzureDevOps.Team("teamResource", new()
{
    ProjectId = "string",
    Administrators = new[]
    {
        "string",
    },
    Description = "string",
    Members = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := azuredevops.NewTeam(ctx, "teamResource", &azuredevops.TeamArgs{
	ProjectId: pulumi.String("string"),
	Administrators: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var teamResource = new Team("teamResource", TeamArgs.builder()
    .projectId("string")
    .administrators("string")
    .description("string")
    .members("string")
    .name("string")
    .build());

    team_resource = azuredevops.Team("teamResource",
    project_id="string",
    administrators=["string"],
    description="string",
    members=["string"],
    name="string")

    const teamResource = new azuredevops.Team("teamResource", {
    projectId: "string",
    administrators: ["string"],
    description: "string",
    members: ["string"],
    name: "string",
});

    type: azuredevops:Team
properties:
    administrators:
        - string
    description: string
    members:
        - string
    name: string
    projectId: string

    Team Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Team resource accepts the following input properties:

    ProjectId string
    The Project ID.
    Administrators List<string>

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    Description string
    The description of the Team.
    Members List<string>

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    Name string
    The name of the Team.
    ProjectId string
    The Project ID.
    Administrators []string

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    Description string
    The description of the Team.
    Members []string

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    Name string
    The name of the Team.
    projectId String
    The Project ID.
    administrators List<String>

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    description String
    The description of the Team.
    members List<String>

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    name String
    The name of the Team.
    projectId string
    The Project ID.
    administrators string[]

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    description string
    The description of the Team.
    members string[]

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    name string
    The name of the Team.
    project_id str
    The Project ID.
    administrators Sequence[str]

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    description str
    The description of the Team.
    members Sequence[str]

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    name str
    The name of the Team.
    projectId String
    The Project ID.
    administrators List<String>

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    description String
    The description of the Team.
    members List<String>

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    name String
    The name of the Team.

    Outputs

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

    Descriptor string
    The descriptor of the Team.
    Id string
    The provider-assigned unique ID for this managed resource.
    Descriptor string
    The descriptor of the Team.
    Id string
    The provider-assigned unique ID for this managed resource.
    descriptor String
    The descriptor of the Team.
    id String
    The provider-assigned unique ID for this managed resource.
    descriptor string
    The descriptor of the Team.
    id string
    The provider-assigned unique ID for this managed resource.
    descriptor str
    The descriptor of the Team.
    id str
    The provider-assigned unique ID for this managed resource.
    descriptor String
    The descriptor of the Team.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        administrators: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        descriptor: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None) -> Team
    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)
    public static Team get(String name, Output<String> id, TeamState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    Administrators List<string>

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    Description string
    The description of the Team.
    Descriptor string
    The descriptor of the Team.
    Members List<string>

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    Name string
    The name of the Team.
    ProjectId string
    The Project ID.
    Administrators []string

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    Description string
    The description of the Team.
    Descriptor string
    The descriptor of the Team.
    Members []string

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    Name string
    The name of the Team.
    ProjectId string
    The Project ID.
    administrators List<String>

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    description String
    The description of the Team.
    descriptor String
    The descriptor of the Team.
    members List<String>

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    name String
    The name of the Team.
    projectId String
    The Project ID.
    administrators string[]

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    description string
    The description of the Team.
    descriptor string
    The descriptor of the Team.
    members string[]

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    name string
    The name of the Team.
    projectId string
    The Project ID.
    administrators Sequence[str]

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    description str
    The description of the Team.
    descriptor str
    The descriptor of the Team.
    members Sequence[str]

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    name str
    The name of the Team.
    project_id str
    The Project ID.
    administrators List<String>

    List of subject descriptors to define administrators of the team.

    NOTE: It's possible to define team administrators both within the azuredevops.Team resource via the administrators block and by using the azuredevops.TeamAdministrators resource. However it's not possible to use both methods to manage team administrators, since there'll be conflicts.

    description String
    The description of the Team.
    descriptor String
    The descriptor of the Team.
    members List<String>

    List of subject descriptors to define members of the team.

    NOTE: It's possible to define team members both within the azuredevops.Team resource via the members block and by using the azuredevops.TeamMembers resource. However it's not possible to use both methods to manage team members, since there'll be conflicts.

    name String
    The name of the Team.
    projectId String
    The Project ID.

    Import

    Azure DevOps teams can be imported using the complete resource id <project_id>/<team_id> e.g.

    $ pulumi import azuredevops:index/team:Team example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure DevOps pulumi/pulumi-azuredevops
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuredevops Terraform Provider.
    azuredevops logo
    Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
    pulumi/pulumi-azuredevops