Remove-VSTeamAgent

SYNOPSIS

Removes an agent from a pool.

SYNTAX

Remove-VSTeamAgent -PoolId <Int32> -Id <Int32[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Removes an agent from a pool.

EXAMPLES

Example 1

Remove-VSTeamAgent -PoolId 101 -Id 2021

Removes the agent with ID `2021` from the pool with ID `101`.

Example 2

$agentIds = 2021, 2022, 2023
Remove-VSTeamAgent -PoolId 101 -Id $agentIds

Removes multiple agents with IDs `2021`, `2022`, and `2023` from the pool with ID `101`.

Example 3

Remove-VSTeamAgent -PoolId 101 -Id 2021 -Force

Removes the agent with ID `2021` from the pool with ID `101` and forces the removal without any confirmation prompts.

PARAMETERS

-PoolId

Id of the pool.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Id

Id of the agent to remove.

Type: Int32[]
Parameter Sets: (All)
Aliases: AgentID

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

-Force

Forces the function without confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WhatIf

Shows what would happen if the function runs. The function is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the function.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

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

RELATED LINKS