Skip to main content

Get-VSTeamClassificationNode

SYNOPSIS​

Gets the classification node for a given node path.

SYNTAX​

ById (Default)​

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

ByPath​

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

DESCRIPTION​

Gets the classification node for a given node path.

EXAMPLES​

Example 1​

Get-VSTeamClassificationNode -StructureGroup "area" -ProjectName "MyProject"

This command retrieves all area classification nodes for the specified project "MyProject".

Example 2​

Get-VSTeamClassificationNode -StructureGroup "iteration" -Depth 2 -ProjectName "MyProject"

This example fetches iteration classification nodes for the "MyProject" with a depth of 2 levels.

Example 3​

Get-VSTeamClassificationNode -Path "MyNodePath" -ProjectName "MyProject"

This command retrieves the classification node associated with the specified node path "MyNodePath" within the "MyProject" project.

Example 4​

Get-VSTeamClassificationNode -Id 12345 -ProjectName "MyProject"

This example demonstrates how to retrieve the classification node in "MyProject" using a specific node ID (12345).

PARAMETERS​

-StructureGroup​

Structure group of the classification node, area or iteration.

Type: String
Parameter Sets: ByPath
Aliases:

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

-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: True
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​

This function is the base function for Get-VSTeamArea and Get-VSTeamIteration.

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-VSTeamArea

Get-VSTeamIteration