Skip to main content

Remove-VSTeam

SYNOPSIS​

Removes a team from a project.

SYNTAX​

Remove-VSTeam [-Id] <String> [-Force] -ProjectName <String> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Removes a team from a project.

EXAMPLES​

Example 1: Remove second team​

Set-DefaultProject Test
Get-VSTeam | Select-Object -First 1 -Skip 1 | Remove-VSTeam

Example 2: Remove team by name​

Remove-VSTeam LastTeam -ProjectName Test -Force

This command removes the team named 'LastTeam'.

Example 2: Remove team by id​

Remove-VSTeam -Id 30246aee-95f8-45cc-9552-bceff1921a40 -Force

This command removes the team with id 30246aee-95f8-45cc-9552-bceff1921a40.

PARAMETERS​

-Id​

The id of the team to remove.

Type: String
Parameter Sets: (All)
Aliases: Name, TeamId, TeamName

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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

-Force​

Forces the function without confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WhatIf​

Shows what would happen if the function runs. The function is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm​

Prompts you for confirmation before running the function.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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