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. .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' } } } |