[BUG] Remove-PnpFile failing in v1.11.0 with parameter issue

[softwareliberationarmy]

Reporting an Issue or Missing Feature

We have a PS script that runs as part of our CI/CD process that installs Pnp.Powershell (no required version) and calls Connect-PnPOnline, Resolve-PnPFolder, Get-PnPFolderItem, and then Remove-PnPFile in a loop (to clean up old files). Starting on July 5th, when v1.11.0 was released, we've noticed that the Remove-PnPFile calls are all failing with what looks like a parameter issue.

Expected behavior

Expecting the Remove-PnPFile command to delete the SP file (actual command syntax being used: Remove-PnPFile -ServerRelativeUrl $file.ServerRelativeUrl -Force)

Actual behavior

Error output:

Remove-PnPFile : Parameter set cannot be resolved using the specified named parameters.
At D:\a\_temp\680a8da3-2a92-4b2f-bd49-4107237ca3ab.ps1:51 char:5
+     Remove-PnPFile -ServerRelativeUrl $file.ServerRelativeUrl -Force
+     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (:) [Remove-PnPFile], ParentContainsErrorRecordException
    + FullyQualifiedErrorId : AmbiguousParameterSet,PnP.PowerShell.Commands.Files.RemoveFile
PowerShell exited with code '1'.

Looking at the code file, I suspect this might be caused by there being two ParameterSetNames for ServerRelativeUrl (these appear to have been added in 1.11.0), and the Force parameter isn't able to break the tie and decide which ParameterSetName to use, hence the "AmbiguousParameterSet" error. But that's just a guess.

Steps to reproduce behavior

Please include complete script or code samples in-line or linked from gists

# SharePoint variables
$SharePointUrl = '$(SP.Url)'
$ClientId = '$(SP.ClientId)'
$ClientSecret = '$(SP.ClientSecret)'
$Directory = '$(SP.TargetFolder)\$(Release.Artifacts.SourceBranchName)'

# Archiving variables
$FilesToKeep = 3

If (!(Get-Module -Name Pnp.Powershell)) {
    Install-Module -Name Pnp.Powershell -Scope 'CurrentUser' -Force
    Import-Module -Name Pnp.Powershell
}

Get-Module -Name Pnp.Powershell 

Connect-PnPOnline -Url $SharePointUrl -ClientId $ClientId -ClientSecret $ClientSecret -WarningAction Ignore
$files = Get-PnPFolderItem -FolderSiteRelativeUrl $Directory -ItemType File

$files | Out-Host

#add additional properties
$groupedFiles = $null
$matchedFiles = @()

$pattern = '(?<major>\d+)_(?<minor>\d+)_(?<patch>\d+)_(?<rev>\d+).zip'

foreach ($file in $files) {
    $fileName = $file.Name
    if ($fileName -match $pattern) {
        $file | Add-Member -MemberType NoteProperty -Name 'Major' -Value ([int]$Matches['major'])
        $file | Add-Member -MemberType NoteProperty -Name 'Minor' -Value ([int]$Matches['minor'])
        $file | Add-Member -MemberType NoteProperty -Name 'Patch' -Value ([int]$Matches['patch'])
        $file | Add-Member -MemberType NoteProperty -Name 'Rev' -Value ([int]$Matches['rev'])
        $matchedFiles += $file
    }
    else {
        Write-Host "##vso[task.LogIssue type=warning;] the file '$fileName' did not match the regular expression '$pattern'. The file will be ignored."
    }    
}

$oldFiles = $matchedFiles | Sort-Object 'Major', 'Minor', 'Patch', 'Rev' -Descending | Select-Object -Skip $FilesToKeep

foreach ($file in $oldFiles) {
    Write-Host "Deleting $($File.Name)..."
    Remove-PnPFile -ServerRelativeUrl $file.ServerRelativeUrl -Force  # <<<< THIS LINE FAILS
    Write-Host "$($File.Name) Deleted"
    Start-Sleep -Milliseconds 200 #Sharepoint has thrown errors if Remove-PnPFile or Move-PnpFile are called too quickly
}

What is the version of the Cmdlet module you are running?

1.11.0

Which operating system/environment are you running PnP PowerShell on?

• Windows
• Linux
• MacOS
• Azure Cloud Shell
• Azure Functions
• [x ] Other : please specify - Azure Remote Build Agent running windows-latest

[softwareliberationarmy]

Addendum: to test out this theory, I tried calling Remove-PnPFile with both -Recycle and -Force (to disambiguate between the two possible ParameterSetNames), and I now see a different error:

Remove-PnPFile : Value does not fall within the expected range.
At D:\a\_temp\847b0583-f763-48b9-9fc6-d93218b7eac8.ps1:53 char:5
+     Remove-PnPFile -ServerRelativeUrl $file.ServerRelativeUrl -Recycl ...
+     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : WriteError: (:) [Remove-PnPFile], ServerException
    + FullyQualifiedErrorId : EXCEPTION,PnP.PowerShell.Commands.Files.RemoveFile
PowerShell exited with code '1'.

[mattatabm]

I can confirm this, we're seeing the same issue. Remove-PnPFile no longer works with release 1.11.0.

I reverted back to 1.10.0 this morning and it works again.

[marc-pinyol]

Same issue here, downgrade to 1.10.0 allowed to bypass temporarily the problem

[JazBInKC]

Had a similar issue with Remove-PnPListItem. That was resolved in 1.10.50

[Cadder]

I can confirm this, we're seeing the same issue. Remove-PnPFile no longer works with release 1.11.0.

I reverted back to 1.10.0 this morning and it works again.

#metoo
During testing:
$pnpFileObj.ServerRelativeURL is valid: /PROJECTS/14/14452/03_Images/Construction/Windows/IMG_8431_a.JPG

Remove-PnPFile -Connection $Conn -ServerRelativeURL $pnpFileObj.ServerRelativeURL -Recycle -Force

Remove-PnPFile : Value does not fall within the expected range.
At C:\NBRS\OneDrive - NBRS\Scripts\_Sharepoint_Maint\NBRS_SPmaint_lib.v1.02.ps1:199 char:1
+ Remove-PnPFile -Connection $Conn -ServerRel ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : WriteError: (:) [Remove-PnPFile], ServerException
    + FullyQualifiedErrorId : EXCEPTION,PnP.PowerShell.Commands.Files.RemoveFile

Remove-PnPFile -Connection $Conn -ServerRelativeURL $pnpFileObj.ServerRelativeURL -Recycle

Remove-PnPFile : Value does not fall within the expected range.
At C:\NBRS\OneDrive - NBRS\Scripts\_Sharepoint_Maint\NBRS_SPmaint_lib.v1.02.ps1:201 char:1
+ Remove-PnPFile -Connection $Conn -ServerRel ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : WriteError: (:) [Remove-PnPFile], ServerException
    + FullyQualifiedErrorId : EXCEPTION,PnP.PowerShell.Commands.Files.RemoveFile

Remove-PnPFile -Connection $Conn -ServerRelativeURL $pnpFileObj.ServerRelativeURL -Force

Remove-PnPFile : Parameter set cannot be resolved using the specified named parameters.
At C:\NBRS\OneDrive - NBRS\Scripts\_Sharepoint_Maint\NBRS_SPmaint_lib.v1.02.ps1:203 char:1
+ Remove-PnPFile -Connection $Conn -ServerRel ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (:) [Remove-PnPFile], ParameterBindingException
    + FullyQualifiedErrorId : AmbiguousParameterSet,PnP.PowerShell.Commands.Files.RemoveFile

Remove-PnPFile -Connection $Conn -ServerRelativeURL $pnpFileObj.ServerRelativeURL

Remove-PnPFile : Parameter set cannot be resolved using the specified named parameters.
At C:\NBRS\OneDrive - NBRS\Scripts\_Sharepoint_Maint\NBRS_SPmaint_lib.v1.02.ps1:205 char:1
+ Remove-PnPFile -Connection $Conn -ServerRel ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (:) [Remove-PnPFile], ParameterBindingException
    + FullyQualifiedErrorId : AmbiguousParameterSet,PnP.PowerShell.Commands.Files.RemoveFile

[Cadder]

WORKAROUND:
I gave up trying to get Remove-PNPFile to work intuitively, but did find an old article here: Why Use Remove-PnPListItem vs Remove-PnPFile? which suggested there is a better way anyway.
(In my case, the Remove-PnPFile command is within a separate function and I'm using more than one site, so I need to specify the -Connection parameter. You may not find it necessary)

Given: $pnpFileObj returns

Name         Type Items/Size Last Modified         
----         ---- ---------- -------------         
IMG_1363.jpg File          0 21/03/2018 12:30:36 AM

and $pnpFileObj.ServerRelativeUrl returns
/PROJECTS/14/14452/03_Images/Construction/Windows/IMG_1363.jpg

$deletedObj = Remove-PnPFile -Connection $Script:Conn -ServerRelativeURL $pnpFileObj.ServerRelativeURL -Recycle -Force
Fails with:

Remove-PnPFile : Value does not fall within the expected range.
At line:1 char:8
+ $del = Remove-PnPFile -Connection $Script:Conn -Se ...
+        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : WriteError: (:) [Remove-PnPFile], ServerException
    + FullyQualifiedErrorId : EXCEPTION,PnP.PowerShell.Commands.Files.RemoveFile

INSTEAD: use Remove-PNPListitem. Thus:
$deletedObj = Remove-PnPListitem -connection $Script:Conn -identity ($pnpFileObj.Listitemallfields) -Recycle -Force
works and $deletedObj returns

RecycleBinItemId                    
----------------                    
f6c08141-e41b-4a29-af2b-e7d43d38671a

[vreezy]

My Workaround
$web = Get-PnPWeb -Connection $site_connection -ErrorVariable error_web -ErrorAction SilentlyContinue;
$path = $web.ServerRelativeUrl + "/SitePages/Home.aspx";
$file = $web.GetFileByServerRelativeUrl($path)
$file.DeleteObject()
Invoke-PnPQuery -RetryCount 5 -Connection $site_connection;

BTW Pls enable Unit-Test again. thx.

[milanholemans]

If I'm not mistaken, we can remove all parameter sets. I don't think they are very useful here.
What do you think @KoenZomers @gautamdsheth?

[damienvanrobaeys]

Same issue here with the 1.11.0, Remove-PnPFile does not work

[rbishop-etq]

Same problem here. wont let me delete when using -serverrelativeurl OR -siterelativeurl
Remove-PnPFile : Parameter set cannot be resolved using the specified named parameters.

Any news for a fix??

[milanholemans]

I made a fix for this issue. Locally it works for me now. Just have to wait for a maintainer to review the changes.