Remove-VSTeamArea
SYNOPSIS
Removes an existing area from the project
SYNTAX
Remove-VSTeamArea -ReClassifyId <Int32> [-Path] <String> -ProjectName <String> [-Force] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Removes an existing area from the project
EXAMPLES
Example 1
Remove-VSTeamArea -ProjectName "Demo" -Path "\MyArea\Path" -ReClassifyId 19
This command removes an existing area with the path \MyArea\Path to the Demo project. Any work items that are assigned to that path get reassigned to the area with the id 19.
Example 2
Get-VSTeamArea | Remove-VSTeamArea "A1" -Force
This command removes an existing area with the path "A1" to the default project. Any work items that are assigned to that path get reassigned to the area with the returned by Get-VSTeamArea.
PARAMETERS
-Path
Path of the area node.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ReClassifyId
Id of an area where work items should be reassigned to if they are currently assigned to the area being deleted.
Type: Int32
Parameter Sets: (All)
Aliases: NodeId
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
-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
OUTPUTS
System.Object
NOTES
This function is a wrapper of the base function Remove-VSTeamClassificationNode.
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