Skip to main content

Add-VSTeamBuildDefinition

SYNOPSIS​

Creates a new build definition from a JSON file.

SYNTAX​

Add-VSTeamBuildDefinition [-InFile] <String> -ProjectName <String> [<CommonParameters>]

DESCRIPTION​

Reads a JSON file off disk and uses that file to create a new build definition in the provided project.

You must call Set-VSTeamAccount before calling this function.

EXAMPLES​

Example 1​

Add-VSTeamBuildDefinition -ProjectName Demo -InFile build.json

This command reads build.json and creates a new build definition from it on the demo team project.

PARAMETERS​

-InFile​

Path and file name to the JSON file that contains the definition to be created. If the path is omitted, the default is the current location.

Type: String
Parameter Sets: (All)
Aliases:

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

System.String​

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