Remove-VSTeamBuildTag

SYNOPSIS

Removes the tag from a build.

SYNTAX

Remove-VSTeamBuildTag [-Tags] <String[]> -Id <Int32[]> [-Force] -ProjectName <String> [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Removes the tag from a build.

EXAMPLES

Example 1

Remove-VSTeamBuildTag -BuildId 1001 -Tag "ReleaseCandidate"

Removes the "ReleaseCandidate" tag from the build with ID `1001`.

Example 2

Remove-VSTeamBuildTag -BuildId 1001 -Tag "ReleaseCandidate" -ProjectName "MyProject"

Removes the "ReleaseCandidate" tag from the build with ID `1001` within the "MyProject" project.

Example 3

$tagsToRemove = "ReleaseCandidate", "Beta", "Alpha"
$tagsToRemove | ForEach-Object { Remove-VSTeamBuildTag -BuildId 1001 -Tag $_ }

Removes multiple tags "ReleaseCandidate", "Beta", and "Alpha" from the build with ID `1001`.

Example 4

Remove-VSTeamBuildTag -BuildId 1001 -Tag "ReleaseCandidate" -Force

Removes the "ReleaseCandidate" tag from the build with ID `1001` and forces the removal without any confirmation prompts.

PARAMETERS

-Id

Specifies one or more builds by ID.

To specify multiple IDs, use commas to separate the IDs.

To find the ID of a build, type Get-VSTeamBuild.

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

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

-Tags

One or more tags. To specify multiple, use commas to separate.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
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

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