Skip to main content

Get-VSTeamBuildTag

SYNOPSIS​

Returns all the tags of a build.

SYNTAX​

Get-VSTeamBuildTag -Id <Int32> -ProjectName <String> [<CommonParameters>]

DESCRIPTION​

Returns all the tags of a build.

EXAMPLES​

Example 1​

Get-VSTeamBuildTag -Id 101 -ProjectName "MyProject"

This command retrieves all tags associated with the build having the ID 101 in the project "MyProject".

Example 2​

Get-VSTeamBuildTag -Id 202 -ProjectName "DevOpsProject"

In this example, all tags related to the build with the ID 202 within the "DevOpsProject" are fetched.

Example 3​

$builds = Get-VSTeamBuild -ProjectName "MyProject"
$builds | ForEach-Object { Get-VSTeamBuildTag -Id $_.Id -ProjectName "MyProject" }

This example demonstrates how to retrieve tags for all builds in the "MyProject". It first fetches all builds in the project and then iterates over each build to retrieve its tags.

Example 4​

Get-VSTeamBuildTag -Id 303 -ProjectName "TestProject" | Where-Object { $_ -like "*release*" }

This command fetches all tags of the build with ID 303 in the "TestProject" and then filters out tags that contain the word "release".

PARAMETERS​

-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

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

System.Object​

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