Update-VSTeamBuild

SYNOPSIS

Allows you to set the keep forever flag and build number.

SYNTAX

Update-VSTeamBuild -Id <Int32> [-KeepForever <Boolean>] [-BuildNumber <String>] [-Force] -ProjectName <String>
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Allows you to set the keep forever flag and build number.

EXAMPLES

Example 1

Get-VSTeamBuild | Update-VSTeamBuild -KeepForever $false

Sets the keep forever property of every build to false.

PARAMETERS

-BuildNumber

The value you want to set as the build number.

Type: String
Parameter Sets: (All)
Aliases:

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

-Id

The id of the build.

Type: Int32
Parameter Sets: (All)
Aliases: BuildID

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

-KeepForever

$True or $False to set the keep forever property of the build.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

vsteam_lib.Build

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

RELATED LINKS