Skip to main content

Get-VSTeamProcess

SYNOPSIS​

Returns a list of process templates in the Team Services or Team Foundation Server account.

SYNTAX​

List (Default)​

Get-VSTeamProcess [<CommonParameters>]

ByName​

Get-VSTeamProcess [[-Name] <Object>] [<CommonParameters>]

ByID​

Get-VSTeamProcess [-Id <String>] [<CommonParameters>]

DESCRIPTION​

The list of Process Templates can be filtered by name (which may include Wildcard). You can also get a single Process Template by id

You must call Set-VSTeamAccount before calling this function.

EXAMPLES​

Example 1​

Get-VSTeamProcess

This will return all the Process Templates

Example 2​

Get-VSTeamProcess | Format-Wide

This will return the Process Templates only showing their name

Example 3​

Get-VSTeamProcess *scrum*

This will return an process templates with names containing scrum, in other words, the default "Scrum" template and custom ones with names like "Custom Scrum", "Scrum for Contoso" will all be returned.

PARAMETERS​

-Name​

Specifies the process template name for which this function operates.

You can tab complete from a list of available process templates.

Type: Object
Parameter Sets: ByName
Aliases: ProcessName, ProcessTemplate

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

The id of the Process Template to return.

Type: String
Parameter Sets: ByID
Aliases: ProcessTemplateID

Required: False
Position: Named
Default value: None
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​

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

Add-VSTeamProject