Skip to main content

Get-VSTeamTfvcRootBranch

SYNOPSIS

Gets root branches for all projects with TFVC source control.

SYNTAX

Get-VSTeamTfvcRootBranch [-IncludeChildren] [-IncludeDeleted] [<CommonParameters>]

DESCRIPTION

Get-VSTeamTfvcRootBranch gets root branches for all projects with TFVC source control.

EXAMPLES

Example 1

Get-VSTeamTfvcRootBranch

This command returns root branches for all projects.

Example 2

Get-VSTeamTfvcRootBranch -IncludeChildren

This command returns root branches for all projects and their respective child branches.

Example 3

Get-VSTeamTfvcRootBranch -IncludeDeleted

This command returns root branches for all projects, also those marked as deleted.

PARAMETERS

-IncludeChildren

Return the child branches for each root branch.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-IncludeDeleted

Return deleted branches.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

NOTES

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