Remove-KshFileVersion.md

external help file	Module Name	online version	schema
SPClientCore.dll-Help.xml	SPClientCore		2.0.0

Remove-KshFileVersion

SYNOPSIS

Removes a file version.

SYNTAX

ParamSet1

Remove-KshFileVersion [-Identity] <FileVersion> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ParamSet2

Remove-KshFileVersion [-Identity] <FileVersion> [-RecycleBin] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

ParamSet3

Remove-KshFileVersion [-File] <File> [-All] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Remove-KshFileVersion cmdlet removes a file version from the file.

EXAMPLES

Example 1

PS C:\> Remove-KshFileVersion -Identity (Get-KshFileVersion -File (Get-KshFile -FileUrl '/sites/japan/hr/Shared%20Documents/README.txt') -FileVersionId 1)

Removes a file version.

Example 2

PS C:\> Remove-KshFileVersion -Identity (Get-KshFileVersion -File (Get-KshFile -FileUrl '/sites/japan/hr/Shared%20Documents/README.txt') -FileVersionId 1) -RecycleBin

Moves a file version to the recycle bin.

Example 3

PS C:\> Remove-KshFileVersion -File (Get-KshFile -FileUrl '/sites/japan/hr/Shared%20Documents/README.txt') -All

Removes all file versions.

PARAMETERS

-All

If specified, removes all file versions.

Type: SwitchParameter
Parameter Sets: ParamSet3
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

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

-File

Specifies the file.

Type: File
Parameter Sets: ParamSet3
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

Specifies the file version.

Type: FileVersion
Parameter Sets: ParamSet1, ParamSet2
Aliases:

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

-RecycleBin

If specified, moves the item to the recycle bin.

Type: SwitchParameter
Parameter Sets: ParamSet2
Aliases:

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

-WhatIf

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

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

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

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider.

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

Karamem0.SharePoint.PowerShell.Models.V1.FileVersion

OUTPUTS

None

NOTES

RELATED LINKS