AzureDevOpsDscNative

1.3.0-preview1

en-US/about_AzDoTeamMember.help.txt

.NAME
    AzDoTeamMember
 
.SYNOPSIS
    DSC resource for managing Azure DevOps team membership.
 
.DESCRIPTION
    This resource manages membership of individual users or groups within a team. The team must
    already exist ? use the AzDoTeam resource to create it first.
 
.PARAMETER ProjectName
    Key - System.String
    The name of the Azure DevOps project. This property is mandatory and serves as a key property for the resource.
 
.PARAMETER TeamName
    Required - System.String
    The name of the team. This is a key property.
 
.PARAMETER MemberName
    Required - System.String
    The UPN, display name, or email of the user or group to add as a team member. This is a key property.
 
.PARAMETER IsTeamAdmin
    Write - System.Boolean
    Whether the member should hold team administrator rights (manage team membership, board columns,
    card rules, backlog settings and dashboards). This property is optional; when it is not set on
    the configuration, the member's team-administrator state is left untouched and defaults to
    $false when the member is newly added. Team administrator rights are implemented as an Access
    Control Entry the member holds in the 'Identity' security namespace on the team's own token,
    which is the same mechanism the Azure DevOps portal's "Administrators" list uses.
 
.EXAMPLE 1
 
This example shows how to add a member to a team in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoTeamMember 'AddAzDoTeamMember'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            TeamName = 'Frontend Team'
            MemberName = 'user@example.com'
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to add a different member to a team in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoTeamMember 'UpdateAzDoTeamMember'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            TeamName = 'Frontend Team'
            MemberName = 'anotheruser@example.com'
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove a member from a team in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoTeamMember 'RemoveAzDoTeamMember'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            TeamName = 'Frontend Team'
            MemberName = 'user@example.com'
        }
    }
}