Skip to main content

Add-VSTeamTaskGroup

SYNOPSIS​

Adds a task group.

SYNTAX​

ByFile​

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

ByBody​

Add-VSTeamTaskGroup -Body <String> -ProjectName <String> [<CommonParameters>]

DESCRIPTION​

Adds a task group.

EXAMPLES​

Example 1​

$taskGroup = Get-VSTeamTaskGroup -Name "taskGroupName" -ProjectName "sourceProjectName"

# Set the ID and revision to null, so AzD is happy.
$taskGroup.id = $null
$taskGroup.revision = $null

$taskGroupJson = ConvertTo-Json -InputObject $taskGroup -Depth 10

Add-VSTeamTaskGroup -Body $taskGroupJson -ProjectName "destinationProjectName"

This example is useful for when one wants to copy an existing task group in one project into another project.

PARAMETERS​

-InFile​

The path to the json file that represents the task group

Type: String
Parameter Sets: ByFile
Aliases:

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

-Body​

The json that represents the task group as a string

Type: String
Parameter Sets: ByBody
Aliases:

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​

System.String​

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

Update-VSTeamTaskGroup

Get-VSTeamTaskGroup

Remove-VSTeamTaskGroup