Get-VSTeamPool
SYNOPSIS
Returns the agent pools.
SYNTAX
List (Default)
Get-VSTeamPool [<CommonParameters>]
ByID
Get-VSTeamPool -Id <Int32> [<CommonParameters>]
DESCRIPTION
Returns the agent pools.
EXAMPLES
Example 1
Get-VSTeamPool
Returns a list of all agent pools.
Example 2
Get-VSTeamPool -Id 12345
Returns the agent pool with the specified `Id` "12345".
Example 3
Get-VSTeamPool | Where-Object { $_.Name -eq "Default" }
Returns the agent pool with the name "Default".
Example 4
Get-VSTeamPool | Sort-Object Name
Returns all agent pools sorted by their name in ascending order.
PARAMETERS
-Id
Id of the pool to return.
Type: Int32
Parameter Sets: ByID
Aliases: PoolID
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