Remove-VSTeamWorkItem

SYNOPSIS

Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.

SYNTAX

Remove-VSTeamWorkItem -Id <Int32[]> [-Destroy] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.

EXAMPLES

Example 1

Remove-VSTeamWorkItem -Id 47,48 -Force

This command deletes work items with IDs 47 and 48 by using the IDs parameter.

Example 2

Remove-VSTeamWorkItem -Id 47

This command deletes the work item with ID 47 by using the ID parameter.

Example 3

Remove-VSTeamWorkItem -Id 47 -Destroy -Force

This command deletes work item with IDs 47 permanently by using the Destroy parameter.

PARAMETERS

-Id

The id of one or more work items.

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

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

-Destroy

Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

ProjectName

OUTPUTS

NOTES

If you do not set the default project by called Set-VSTeamDefaultProject before calling Get-VSTeamWorkItem you will have to type in the names.

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