Merge pull request #2778 from lilealdai/supportLargeListDelete

Add support for large list recycle for Remove-PnPList
pnp · Feb 8, 2023 · d05347d · d05347d
2 parents 2f4c87d + 1e5441b
commit d05347d
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 4 deletions.
diff --git a/documentation/Remove-PnPList.md b/documentation/Remove-PnPList.md
@@ -15,7 +15,7 @@ Deletes a list.
 ## SYNTAX
 
 ```powershell
-Remove-PnPList [-Identity] <ListPipeBind> [-Recycle] [-Force] [-Connection <PnPConnection>]
+Remove-PnPList [-Identity] <ListPipeBind> [-Recycle] [-LargeList] [-Force] [-Connection <PnPConnection>]
 ```
 
 ## DESCRIPTION
@@ -45,6 +45,14 @@ Remove-PnPList -Identity Announcements -Recycle
 
 Removes the list named 'Announcements' and moves it to the Recycle Bin.
 
+### EXAMPLE 4
+```powershell
+Remove-PnPList -Identity Announcements -Recycle -LargeList
+```
+
+Removes the large list named 'Announcements' and moves it to the Recycle Bin.
+
+
 ## PARAMETERS
 
 ### -Connection
@@ -103,6 +111,20 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -LargeList
+When provided, the large list will be moved to recycle bin through a timer job. It must be paired with the Recycle Parameter.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ## RELATED LINKS
 
 [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
diff --git a/src/Commands/Lists/RemoveList.cs b/src/Commands/Lists/RemoveList.cs
@@ -24,6 +24,9 @@ public class RemoveList : PnPWebCmdlet
 
         [Parameter(Mandatory = false)]
         public SwitchParameter Force;
+
+        [Parameter(Mandatory = false)]
+        public SwitchParameter LargeList;
         protected override void ExecuteCmdlet()
         {
             var list = Identity.GetList(CurrentWeb);
@@ -33,9 +36,18 @@ protected override void ExecuteCmdlet()
                 {
                     if (Recycle)
                     {
-                        var recycleResult = list.Recycle();
-                        ClientContext.ExecuteQueryRetry();
-                        WriteObject(new RecycleResult { RecycleBinItemId = recycleResult.Value });
+                        if (LargeList)
+                        {
+                            var operationId = list.StartRecycle();
+                            ClientContext.ExecuteQueryRetry();
+                            WriteObject($"Large List Operation Job {operationId.Value} initiated. It may take a while for this job to complete.");
+                        }
+                        else
+                        { 
+                            var recycleResult = list.Recycle();
+                            ClientContext.ExecuteQueryRetry();
+                            WriteObject(new RecycleResult { RecycleBinItemId = recycleResult.Value });
+                        }
                     }
                     else
                     {