Link

Set-TfsIteration

Modifies the dates of an iteration.


Table of Contents

  1. Syntax
  2. Parameters
  3. Inputs
  4. Outputs
  5. Related Links

Syntax

Set by finish date

Set-TfsIteration
    [-Node <object>]
    -FinishDate <DateTime>
    -StartDate <DateTime>
    [-Collection <object>]
    [-Passthru]
    [-Project <object>]
    [-Server <object>]

Set by iteration length

Set-TfsIteration
    [-Node <object>]
    -Length <int>
    -StartDate <DateTime>
    [-Collection <object>]
    [-Passthru]
    [-Project <object>]
    [-Server <object>]

[Go to top]

Parameters

-Collection (Aliases: Organization)

Specifies the URL to the Team Project Collection or Azure DevOps Organization to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organizations by simply providing its name instead of the full URL. For more details, see the Get-TfsTeamProjectCollection cmdlet. When omitted, it defaults to the connection set by Connect-TfsTeamProjectCollection (if any).

Type object
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-FinishDate

Sets the finish date of the iteration. To clear the finish date, set it to $null. Note that when clearing a date, both must be cleared at the same time (i.e. setting both StartDate and FinishDate to $null).

Type DateTime
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-Length

Sets the length (in days) of the iteration. To clear the finish date, set it to 0. Note that when clearing a date, both must be cleared at the same time (i.e. setting both StartDate to $null and Length to 0).

Type int
Position (Named)
Default Value 0
Accept pipeline input False
Accept wildcard characters False

-Node (Aliases: Path, Iteration)

Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash (‘') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of ‘vstfs:///Classification/Node/{GUID}’ (where {GUID} is the unique identifier of the given node).

Type object
Position 0
Default Value (N/A)
Accept pipeline input True (byvalue)
Accept wildcard characters False

-Passthru

Returns the results of the command. By default, this cmdlet does not generate any output.

Type SwitchParameter
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-Project

Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeamProject (if any). For more details, see the Get-TfsTeamProject cmdlet.

Type object
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-Server

Specifies the URL to the Team Foundation Server to connect to, a TfsConfigurationServer object (Windows PowerShell only), or a VssConnection object. When omitted, it defaults to the connection set by Connect-TfsConfiguration (if any). For more details, see the Get-TfsConfigurationServer cmdlet.

Type object
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-StartDate

Specifies the start date of the iteration. To clear the start date, set it to $null. Note that when clearing a date, both must be cleared at the same time (i.e. setting both StartDate and FinishDate to $null).

Type DateTime
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

Inputs

System.Object

Specifies the name, URI or path of an Iteration. Wildcards are supported. When omitted, all Iterations in the given Team Project are returned.nnTo supply a path, use a backslash (‘') between the path segments. Leading and trailing backslashes are optional.nnWhen supplying a URI, use URIs in the form of ‘vstfs:///Classification/Node/{GUID}’ (where {GUID} is the unique identifier of the given node).

Outputs

TfsCmdlets.Models.ClassificationNode