Update-VSTeamIteration
SYNOPSIS
Updates an iteration's properties in a project
SYNTAX
Update-VSTeamIteration [-Name <String>] -Path <String> [-StartDate <DateTime>] [-FinishDate <DateTime>]
[-Force] -ProjectName <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an iteration's properties in a project
EXAMPLES
Example 1
Update-VSTeamIteration -ProjectName Demo -Name "NewIterationName" -Path "MyIteration/Path"
This command updates an iteration with the specified path to the name NewIterationName (which will change the path) in the Demo project. Additionally, because no dates are specified, if any dates did previously exist, they would be "unset."
Example 2
Update-VSTeamArea -Name "NewIterationName" -Path "MyIteration/Path" -FinishDate "31.01.2020" -StartDate "01.01.2020"
This command updates an area with the specified path to the name NewIterationName (which will change the path) in the default project with the start date 01.01.2020 and finish date 31.01.2020.
PARAMETERS
-Name
New name of the iteration.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
Path of the existing iteration that will be updated.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StartDate
Start date of the iteration.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FinishDate
Finish date of the iteration.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProjectName
Specifies the team project for which this function operates.
You can tab complete from a list of available projects.
You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Force
Forces the function without confirmation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the function runs. The function is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the function.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
System.Object
NOTES
This function is a wrapper of the base function Update-VSTeamClassificationNode.
Prerequisites:
Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.
tips:
- check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
- use Set-VSTeamDefaultProject to set default project for every call
- use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
- use Profiles to load an account and the correct version