Skip to main content

Get-VSTeam

SYNOPSIS​

Returns a team.

SYNTAX​

List (Default)​

Get-VSTeam [-Top <Int32>] [-Skip <Int32>] -ProjectName <String> [<CommonParameters>]

ByName​

Get-VSTeam [[-Name] <String[]>] -ProjectName <String> [<CommonParameters>]

ByID​

Get-VSTeam [-Id <String[]>] -ProjectName <String> [<CommonParameters>]

DESCRIPTION​

Returns a team.

EXAMPLES​

Example 1: Get team by name​

Get-VSTeamProject | Get-VSTeam 'Test Team'

This command pipes the project name to Get-VSTeam and returns the team with the name 'Test Team'

PARAMETERS​

-Skip​

The number of items to skip.

Type: Int32
Parameter Sets: List
Aliases:

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

-Top​

Specifies the maximum number to return.

Type: Int32
Parameter Sets: List
Aliases:

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

-Name​

The name of the team to retrieve.

Type: String[]
Parameter Sets: ByName
Aliases: TeamName

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

-Id​

The id of the team to retrieve.

Type: String[]
Parameter Sets: ByID
Aliases: TeamId

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​

vsteam_lib.Team​

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