Skip to content

Commit 6c4fbef

Browse files
authored
Update Restore-PnPRecycleBinItem.md
Added information about the new parameter set. Added example and parameter information.
1 parent aa6dd0e commit 6c4fbef

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

documentation/Restore-PnPRecycleBinItem.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,12 @@ Restores the provided recycle bin item to its original location.
1818
Restore-PnPRecycleBinItem -Identity <RecycleBinItemPipeBind> [-Force] [-RowLimit <Int32>]
1919
[-Connection <PnPConnection>]
2020
```
21+
```powershell
22+
Restore-PnPRecycleBinItem -IdList <string[]> [-Connection <PnPConnection>]
23+
```
2124

2225
## DESCRIPTION
23-
This cmdlet restores the specified item from the recycle bin to its original location.
26+
This cmdlet restores the specified item or set of items from the recycle bin to its original location.
2427

2528
## EXAMPLES
2629

@@ -45,6 +48,13 @@ Get-PnPRecycleBinItem -RowLimit 10000 | Restore-PnPRecycleBinItem -Force
4548

4649
Permanently restores up to 10,000 items in the recycle bin without asking for confirmation.
4750

51+
### EXAMPLE 4
52+
```powershell
53+
Restore-PnPRecycleBinItem -IdList @("31897b05-fd3b-4c49-9898-2e7f10e59cac","b16f0733-9b07-4ef3-a4b6-896edca4babd", "367ef9d2-6080-45ea-9a03-e8c9029f59dd")
54+
```
55+
56+
Restores the recycle bin items with Id 31897b05-fd3b-4c49-9898-2e7f10e59cac, b16f0733-9b07-4ef3-a4b6-896edca4babd, 367ef9d2-6080-45ea-9a03-e8c9029f59dd to their original location.
57+
4858
## PARAMETERS
4959

5060
### -Connection
@@ -66,7 +76,7 @@ If provided, no confirmation will be asked to restore the recycle bin item.
6676
6777
```yaml
6878
Type: SwitchParameter
69-
Parameter Sets: (All)
79+
Parameter Sets: (Restore Single Item By Id)
7080

7181
Required: False
7282
Position: Named
@@ -80,7 +90,7 @@ Id of the recycle bin item or the recycle bin item object itself to restore.
8090
8191
```yaml
8292
Type: RecycleBinItemPipeBind
83-
Parameter Sets: (All)
93+
Parameter Sets: (Restore Single Item By Id)
8494

8595
Required: False
8696
Position: Named
@@ -90,18 +100,31 @@ Accept wildcard characters: False
90100
```
91101
92102
### -RowLimit
93-
Limits restoration to specified number of items.
103+
Limits restoration to a specified number of items.
94104
95105
```yaml
96106
Type: Int32
97-
Parameter Sets: (All)
107+
Parameter Sets: (Restore Single Item By Id)
98108

99109
Required: False
100110
Position: Named
101111
Default value: None
102112
Accept pipeline input: False
103113
Accept wildcard characters: False
104114
```
115+
### -IdList
116+
String array of Recycle Bin Item Ids
117+
118+
```yaml
119+
Type: String array
120+
Parameter Sets: (Restore Multiple Items By Id)
121+
122+
Required: True
123+
Position: Named
124+
Default value: None
125+
Accept pipeline input: False
126+
Accept wildcard characters: False
127+
```
105128
106129
## RELATED LINKS
107130

0 commit comments

Comments
 (0)