Remove-VSTeamRelease
SYNOPSIS
Removes the releases for a team project.
SYNTAX
Remove-VSTeamRelease -Id <Int32[]> [-Force] -ProjectName <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The Remove-VSTeamRelease function removes the releases for a team project.
The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory.
EXAMPLES
Example 1
Get-VSTeamRelease -ProjectName demo | Remove-VSTeamRelease
This command gets a list of all releases in the demo project.
The pipeline operator (|) passes the data to the Remove-VSTeamRelease function, which removes each release definition object.
PARAMETERS
-Id
Specifies one or more releases by ID.
To specify multiple IDs, use commas to separate the IDs.
To find the ID of a release definition, type Get-VSTeamRelease.
Type: Int32[]
Parameter Sets: (All)
Aliases:
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
None
NOTES
You can pipe release definition IDs to this function.
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