Get-VSTeamBuildDefinition
SYNOPSIS
Gets the build definitions for a team project.
SYNTAX
List (Default)
Get-VSTeamBuildDefinition [-Filter <String>] [-JSON] -ProjectName <String> [<CommonParameters>]
ByID
Get-VSTeamBuildDefinition -Id <Int32[]> [-Revision <Int32>] [-JSON] -ProjectName <String> [<CommonParameters>]
ByIdRaw
Get-VSTeamBuildDefinition -Id <Int32[]> [-Revision <Int32>] [-JSON] [-raw] -ProjectName <String>
[<CommonParameters>]
DESCRIPTION
The Get-VSTeamBuildDefinition function gets the build definitions for a team project.
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 gets all of the build definitions for that team project.
You can also specify a particular build definition by ID.
EXAMPLES
Example 1
Get-VSTeamBuildDefinition -ProjectName Demo | Format-List *
This command gets a list of all build definitions in the demo project.
The pipeline operator (|) passes the data to the Format-List cmdlet, which displays all available properties (*) of the build definition objects.
Example 2
Get-VSTeamBuildDefinition -ProjectName Demo -id 2 -Json
This command returns the raw object returned from the server formatted as a JSON string.
Example 3
Get-VSTeamBuildDefinition -ProjectName Demo -id 2 -Raw
This command returns the raw object returned from the server.
PARAMETERS
-Filter
Filters to definitions whose names equal this value. Append a to filter to definitions whose names start with this value. For example: MS
Type: String
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
Specifies one or more build definitions by ID.
To specify multiple IDs, use commas to separate the IDs.
To find the ID of a build definition, type Get-VSTeamBuildDefinition.
Type: Int32[]
Parameter Sets: ByID
Aliases: BuildDefinitionID
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Type: Int32[]
Parameter Sets: ByIdRaw
Aliases: BuildDefinitionID
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Revision
Specifies the specific revision number of the definition to retrieve.
Type: Int32
Parameter Sets: ByID, ByIdRaw
Aliases:
Required: False
Position: Named
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False
-JSON
Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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
-raw
Returns the raw response. This is required when you need to use the object to send back. Without this switch the object produced from the returned object will not match the expected shape of the JSON for sending back to server.
Type: SwitchParameter
Parameter Sets: ByIdRaw
Aliases:
Required: True
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.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