Get-VSTeamQueue

SYNOPSIS

Gets a agent queue.

SYNTAX

List (Default)

Get-VSTeamQueue [-queueName <String>] [-actionFilter <String>] -ProjectName <String> [<CommonParameters>]

ByID

Get-VSTeamQueue [-id <String>] -ProjectName <String> [<CommonParameters>]

DESCRIPTION

Gets a agent queue.

EXAMPLES

Example 1

Get-VSTeamQueue -ProjectName "MyProject"

Returns a list of all agent queues for the specified project "MyProject".

Example 2

Get-VSTeamQueue -QueueName "BuildQueue" -ProjectName "MyProject"

Returns the agent queue with the name "BuildQueue" for the specified project "MyProject".

Example 3

Get-VSTeamQueue -Id "12345" -ProjectName "MyProject"

Returns the agent queue with the specified `Id` "12345" for the project "MyProject".

Example 4

Get-VSTeamQueue -ActionFilter "Manage" -ProjectName "MyProject"

Returns the agent queues for the project "MyProject" where the action filter is set to "Manage".

Example 5

Get-VSTeamQueue -ProjectName "MyProject" | Where-Object { $_.QueueName -like "*Test*" }

Returns all agent queues for the project "MyProject" where the queue name contains the word "Test".

PARAMETERS

-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

-actionFilter

None, Manage or Use.

Type: String
Parameter Sets: List
Aliases:

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

-id

Id of the queue to return.

Type: String
Parameter Sets: ByID
Aliases: QueueID

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

-queueName

Name of the queue to return.

Type: String
Parameter Sets: List
Aliases:

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

vsteam_lib.Queue

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

RELATED LINKS