Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. TeamMembers
Azure DevOps v3.9.0 published on Tuesday, Apr 22, 2025 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.TeamMembers

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.9.0 published on Tuesday, Apr 22, 2025 by Pulumi
pulumi/pulumi-azuredevops

    Manages members of 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 Pulumi",
});
const example_project_readers = azuredevops.getGroupOutput({
    projectId: example.id,
    name: "Readers",
});
const exampleTeam = new azuredevops.Team("example", {
    projectId: example.id,
    name: pulumi.interpolate`${example.name} Team 2`,
});
const example_team_members = new azuredevops.TeamMembers("example-team-members", {
    projectId: exampleTeam.projectId,
    teamId: exampleTeam.id,
    mode: "overwrite",
    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 Pulumi")
example_project_readers = azuredevops.get_group_output(project_id=example.id,
    name="Readers")
example_team = azuredevops.Team("example",
    project_id=example.id,
    name=example.name.apply(lambda name: f"{name} Team 2"))
example_team_members = azuredevops.TeamMembers("example-team-members",
    project_id=example_team.project_id,
    team_id=example_team.id,
    mode="overwrite",
    members=[example_project_readers.descriptor])

    package main

import (
	"fmt"

	"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 Pulumi"),
		})
		if err != nil {
			return err
		}
		example_project_readers := azuredevops.LookupGroupOutput(ctx, azuredevops.GetGroupOutputArgs{
			ProjectId: example.ID(),
			Name:      pulumi.String("Readers"),
		}, nil)
		exampleTeam, err := azuredevops.NewTeam(ctx, "example", &azuredevops.TeamArgs{
			ProjectId: example.ID(),
			Name: example.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf("%v Team 2", name), nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewTeamMembers(ctx, "example-team-members", &azuredevops.TeamMembersArgs{
			ProjectId: exampleTeam.ProjectId,
			TeamId:    exampleTeam.ID(),
			Mode:      pulumi.String("overwrite"),
			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 Pulumi",
    });

    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.Name.Apply(name => $"{name} Team 2"),
    });

    var example_team_members = new AzureDevOps.TeamMembers("example-team-members", new()
    {
        ProjectId = exampleTeam.ProjectId,
        TeamId = exampleTeam.Id,
        Mode = "overwrite",
        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 com.pulumi.azuredevops.TeamMembers;
import com.pulumi.azuredevops.TeamMembersArgs;
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 Pulumi")
            .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.name().applyValue(_name -> String.format("%s Team 2", _name)))
            .build());

        var example_team_members = new TeamMembers("example-team-members", TeamMembersArgs.builder()
            .projectId(exampleTeam.projectId())
            .teamId(exampleTeam.id())
            .mode("overwrite")
            .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 Pulumi
  exampleTeam:
    type: azuredevops:Team
    name: example
    properties:
      projectId: ${example.id}
      name: ${example.name} Team 2
  example-team-members:
    type: azuredevops:TeamMembers
    properties:
      projectId: ${exampleTeam.projectId}
      teamId: ${exampleTeam.id}
      mode: overwrite
      members:
        - ${["example-project-readers"].descriptor}
variables:
  example-project-readers:
    fn::invoke:
      function: azuredevops:getGroup
      arguments:
        projectId: ${example.id}
        name: Readers

    PAT Permissions Required

    • vso.project_write: Grants the ability to read and update projects and teams.

    Create TeamMembers Resource

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

    Constructor syntax

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

@overload
def TeamMembers(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                members: Optional[Sequence[str]] = None,
                project_id: Optional[str] = None,
                team_id: Optional[str] = None,
                mode: Optional[str] = None)
    func NewTeamMembers(ctx *Context, name string, args TeamMembersArgs, opts ...ResourceOption) (*TeamMembers, error)
    public TeamMembers(string name, TeamMembersArgs args, CustomResourceOptions? opts = null)
    public TeamMembers(String name, TeamMembersArgs args)
public TeamMembers(String name, TeamMembersArgs args, CustomResourceOptions options)

    type: azuredevops:TeamMembers
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 TeamMembersArgs
    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 TeamMembersArgs
    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 TeamMembersArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TeamMembersArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TeamMembersArgs
    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 teamMembersResource = new AzureDevOps.TeamMembers("teamMembersResource", new()
{
    Members = new[]
    {
        "string",
    },
    ProjectId = "string",
    TeamId = "string",
    Mode = "string",
});

    example, err := azuredevops.NewTeamMembers(ctx, "teamMembersResource", &azuredevops.TeamMembersArgs{
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	ProjectId: pulumi.String("string"),
	TeamId:    pulumi.String("string"),
	Mode:      pulumi.String("string"),
})

    var teamMembersResource = new TeamMembers("teamMembersResource", TeamMembersArgs.builder()
    .members("string")
    .projectId("string")
    .teamId("string")
    .mode("string")
    .build());

    team_members_resource = azuredevops.TeamMembers("teamMembersResource",
    members=["string"],
    project_id="string",
    team_id="string",
    mode="string")

    const teamMembersResource = new azuredevops.TeamMembers("teamMembersResource", {
    members: ["string"],
    projectId: "string",
    teamId: "string",
    mode: "string",
});

    type: azuredevops:TeamMembers
properties:
    members:
        - string
    mode: string
    projectId: string
    teamId: string

    TeamMembers 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 TeamMembers resource accepts the following input properties:

    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.

    ProjectId string
    The Project ID.
    TeamId string
    The ID of the Team.
    Mode string

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

    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.

    ProjectId string
    The Project ID.
    TeamId string
    The ID of the Team.
    Mode string

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

    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.

    projectId String
    The Project ID.
    teamId String
    The ID of the Team.
    mode String

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

    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.

    projectId string
    The Project ID.
    teamId string
    The ID of the Team.
    mode string

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

    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.

    project_id str
    The Project ID.
    team_id str
    The ID of the Team.
    mode str

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

    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.

    projectId String
    The Project ID.
    teamId String
    The ID of the Team.
    mode String

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing TeamMembers Resource

    Get an existing TeamMembers 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?: TeamMembersState, opts?: CustomResourceOptions): TeamMembers
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        members: Optional[Sequence[str]] = None,
        mode: Optional[str] = None,
        project_id: Optional[str] = None,
        team_id: Optional[str] = None) -> TeamMembers
    func GetTeamMembers(ctx *Context, name string, id IDInput, state *TeamMembersState, opts ...ResourceOption) (*TeamMembers, error)
    public static TeamMembers Get(string name, Input<string> id, TeamMembersState? state, CustomResourceOptions? opts = null)
    public static TeamMembers get(String name, Output<String> id, TeamMembersState state, CustomResourceOptions options)
    resources:  _:    type: azuredevops:TeamMembers    get:      id: ${id}
    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:
    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.

    Mode string

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

    ProjectId string
    The Project ID.
    TeamId string
    The ID 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.

    Mode string

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

    ProjectId string
    The Project ID.
    TeamId string
    The ID 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.

    mode String

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

    projectId String
    The Project ID.
    teamId String
    The ID 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.

    mode string

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

    projectId string
    The Project ID.
    teamId string
    The ID 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.

    mode str

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

    project_id str
    The Project ID.
    team_id str
    The ID 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.

    mode String

    The mode how the resource manages team members. Possible values: add, overwrite. Defaults to add.

    NOTE: 1. mode = add: the resource will ensure that all specified members will be part of the referenced team 2. mode = overwrite: the resource will replace all existing members with the members specified within the members block

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

    Import

    The resource does not support import.

    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.9.0 published on Tuesday, Apr 22, 2025 by Pulumi
    pulumi/pulumi-azuredevops