Skip to main content

Update-VSTeam

SYNOPSIS​

Updates the team name, description or both.

SYNTAX​

UpdateDescription (Default)​

Update-VSTeam [-Name] <String> -Description <String> [-Force] -ProjectName <String> [-WhatIf] [-Confirm]
 [<CommonParameters>]

UpdateName​

Update-VSTeam [-Name] <String> -NewTeamName <String> [-Description <String>] [-Force] -ProjectName <String>
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Updates the team name, description or both.

EXAMPLES​

Example 1​

Update-VSTeam -Name "OldTeamName" -NewTeamName "NewTeamName"

Updates the team name from "OldTeamName" to "NewTeamName".

Example 2​

Update-VSTeam -Name "TeamName" -Description "Updated Team Description"

Updates the description of the team named "TeamName" to "Updated Team Description".

Example 3​

Update-VSTeam -Name "TeamName" -NewTeamName "NewTeamName" -ProjectName "MyProject"

Updates the team name within the "MyProject" project from "TeamName" to "NewTeamName".

Example 4​

Update-VSTeam -Name "TeamName" -NewTeamName "NewTeamName" -Force

Updates the team name from "TeamName" to "NewTeamName" and forces the update without any confirmation prompts.

PARAMETERS​

-Name​

The name of the team to update

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

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NewTeamName​

The new name of the team

Type: String
Parameter Sets: UpdateName
Aliases:

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

-Description​

The new description of the team

Type: String
Parameter Sets: UpdateDescription
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: UpdateName
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

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

System.String​

Description

Name

NewTeamName

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