en-US/about_AzDoTeamSettings.help.txt
|
.NAME
AzDoTeamSettings .SYNOPSIS DSC resource for managing the iteration and area-path configuration of an Azure DevOps team. .DESCRIPTION Allows the iteration paths (default iteration, backlog iteration and the iterations assigned to the team) and the area paths (default area path and the team's area paths) to be declared as part of how a team is configured. .PARAMETER ProjectName Key - System.String The name of the Azure DevOps project. This property is mandatory and serves as the key property for the resource. .PARAMETER TeamName Required - System.String The name of the team whose settings are managed. This property is mandatory. .PARAMETER BacklogIterationPath Write - System.String The backlog iteration path for the team. .PARAMETER DefaultIterationPath Write - System.String The default iteration path for new work items. .PARAMETER IterationPaths Write - System.String[] .PARAMETER DefaultAreaPath Write - System.String The default area path for the team. .PARAMETER AreaPaths Write - System.String[] .PARAMETER WorkingDays Write - System.String[] .PARAMETER BugsBehavior Write - System.String Allowed values: , asRequirements, asTasks, off How bugs are shown on backlogs and boards. Valid values are asRequirements, asTasks and off. .PARAMETER BacklogVisibilities Write - HashTable Which backlog levels the team's backlogs and boards show, as a hashtable of backlog category reference name to boolean, e.g. @{ 'Microsoft.EpicCategory' = $true; 'Microsoft.FeatureCategory' = $false }. Only the categories present in this hashtable are compared and applied; any category the configuration does not mention is left at whatever the team currently has. .EXAMPLE 1 This example shows how to configure the iteration and area paths for an Azure DevOps team. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoTeamSettings 'ConfigureFrontendTeam' { Ensure = 'Present' ProjectName = 'MyProject' TeamName = 'Frontend Team' # Iteration configuration BacklogIterationPath = 'MyProject' DefaultIterationPath = 'MyProject\Sprint 1' IterationPaths = @('MyProject\Sprint 1', 'MyProject\Sprint 2') # Area-path configuration DefaultAreaPath = 'MyProject\Frontend' AreaPaths = @('MyProject\Frontend', 'MyProject\Frontend\Web') # General team settings WorkingDays = @('monday', 'tuesday', 'wednesday', 'thursday', 'friday') BugsBehavior = 'asRequirements' } } } |