Skip to main content

Get-VSTeamIteration

SYNOPSIS​

Gets the iteration node for a given iteration path.

SYNTAX​

ByPath (Default)​

Get-VSTeamIteration [-Path <String>] [-Depth <Int32>] -ProjectName <String> [<CommonParameters>]

ById​

Get-VSTeamIteration [-Id <Int32[]>] [-Depth <Int32>] -ProjectName <String> [<CommonParameters>]

DESCRIPTION​

Gets the iteration node for a given iteration path.

EXAMPLES​

Example 1​

Get-VSTeamIteration -Path '\ProjectX\Sprint1'

This command returns the iteration node for the given iteration path '\ProjectX\Sprint1'.

Example 2​

Get-VSTeamIteration -Id 12345

This command returns the iteration node for the given classification node id 12345.

Example 3​

Get-VSTeamIteration -Path '\ProjectX\Sprint1' -Depth 2

This command returns the iteration node for the given iteration path '\ProjectX\Sprint1' and fetches children up to a depth of 2.

Example 4​

Get-VSTeamIteration -ProjectName 'ProjectX' | Where-Object { $_.Name -eq "Sprint1" }

This command retrieves all iteration nodes from 'ProjectX' and then filters out to display only the node named "Sprint1".

Example 5​

Get-VSTeamIteration -Path '\ProjectX\Sprint1' -ProjectName 'ProjectX'

This command retrieves the iteration node with the path '\ProjectX\Sprint1' that is part of 'ProjectX'.

PARAMETERS​

-Depth​

Depth of children to fetch.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path​

Path of the classification node.

Type: String
Parameter Sets: ByPath
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

Integer classification nodes ids.

Type: Int32[]
Parameter Sets: ById
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

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​

Keep in mind that the `Get-VSTeamIteration` function is a wrapper for `Get-VSTeamClassificationNode` and will retrieve iteration nodes. If you need to retrieve areas or other classification nodes, you should use the `Get-VSTeamClassificationNode` function directly. Always ensure the correct path and project name are provided to get accurate results.

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

Get-VSTeamClassificationNode

Get-VSTeamIteration