Show-VSTeamBuildDefinition
SYNOPSIS
Opens the build definition in the default browser.
SYNTAX
List (Default)
Show-VSTeamBuildDefinition [-Type <String>] [-Path <String>] -ProjectName <String> [<CommonParameters>]
ByID
Show-VSTeamBuildDefinition -Id <Int32[]> -ProjectName <String> [<CommonParameters>]
DESCRIPTION
Opens the build definition in the default browser.
The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory.
With just a project name, this function shows all of the build definitions for that team project.
You can also specify a particular build definition by ID.
EXAMPLES
Example 1
Show-VSTeamBuildDefinition -ProjectName Demo
This command will open a web browser with All Definitions for this project showing.
PARAMETERS
-Type
The type of the build definitions to retrieve. The acceptable values for this parameter are:
- Mine
- All
- Queued
- XAML
If not specified, all types will be returned.
Type: String
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: All
Accept pipeline input: False
Accept wildcard characters: False
-Path
The folder of the build definitions to retrieve.
Type: String
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: \
Accept pipeline input: False
Accept wildcard characters: False
-Id
Specifies build definition by ID.
Type: Int32[]
Parameter Sets: ByID
Aliases: BuildDefinitionID
Required: True
Position: Named
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
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.BuildDefinition
NOTES
You can pipe build definition IDs to this function.
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