Skip to content

Commit 0825a4c

Browse files
authored
Merge pull request MicrosoftDocs#10512 from brenle/patch-4
Update Get-ReviewItems.md
2 parents 7eba286 + 748eecf commit 0825a4c

File tree

1 file changed

+61
-7
lines changed

1 file changed

+61
-7
lines changed

exchange/exchange-ps/exchange/Get-ReviewItems.md

Lines changed: 61 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ ms.reviewer:
1414
## SYNOPSIS
1515
This cmdlet is available only in the cloud-based service.
1616

17-
Use the Get-ReviewItems to ???.
17+
Use the Get-ReviewItems to retrieve a list of disposition review items that are either pending review or already disposed for a specific retention label. It can also be used to retrieve a list of disposed items for a specific record label.
18+
19+
This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group).
1820

1921
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
2022

@@ -31,19 +33,60 @@ Get-ReviewItems -TargetLabelId <String>
3133
## DESCRIPTION
3234
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
3335

36+
The `Get-ReviewItems` cmdlet can be used to export a list of pending or disposed items from disposition review. To learn more about disposition review, see [Disposition of content](https://learn.microsoft.com/microsoft-365/compliance/disposition).
37+
3438
## EXAMPLES
3539

3640
### Example 1
41+
42+
```powershell
43+
$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true
44+
45+
$formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers
46+
47+
$formattedExportItems
48+
```
49+
50+
This example retrieves the first page of items pending disposition for the label with the immutable ID value `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. The results are converted to PSObject types for each item and then output to the screen.
51+
52+
### Example 2
53+
54+
```powershell
55+
$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -Disposed $true
56+
57+
$formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers
58+
59+
$formattedExportItems | Select Subject,Location,ReviewAction,Comment,DeletedBy,DeletedDate
60+
```
61+
62+
This example retrieves all disposed items for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9` and selects specific columns to output to the screen.
63+
64+
### Example 3
65+
3766
```powershell
38-
PS C:\> {{ Add example code here }}
67+
$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true
68+
69+
$exportItems = $itemsPendingDisposition.ExportItems
70+
71+
While (![string]::IsNullOrEmpty($itemsPendingDisposition.PaginationCookie))
72+
{
73+
$itemsPendingDisposition = $itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -PagingCookie $itemsPendingDisposition.PaginationCookie
74+
$exportItems += $itemsPendingDisposition.ExportItems
75+
}
76+
77+
$exportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers | Export-Csv C:\temp\ItemsPendingDisposition.csv -NoTypeInformation
3978
```
4079

41-
{{ Add example description here }}
80+
This example retrieves all items pending disposition for the label with the immutable ID value `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. If multiple pages of items exist, the command continues until no more pages exist. The results are exported to the specified CSV file.
81+
82+
**Note**: While the cmdlet does not impose any limit to the number of items/pages that can be retrieved, other throttling may occur. To prevent throttling while retrieving a large number of items, we recommended including breaks in your script. You can use the PagingCookie parameter to pick up where the script left off after a break.
4283

4384
## PARAMETERS
4485

4586
### -TargetLabelId
46-
{{ Fill TargetLabelId Description }}
87+
The TargetLabelId parameter specifies the label that you want to retrieve review items for. A valid value for this parameter is the immutable ID of the label.
88+
89+
To get the immutable ID value of a label, replace \<RetentionLabelName\> with the name of the label, and then run the following command in Exchange Online PowerShell: `Get-ComplianceTag -Identity "<RetentionLabelName>" | select ImmutableId`.
4790

4891
```yaml
4992
Type: String
@@ -59,7 +102,10 @@ Accept wildcard characters: False
59102
```
60103
61104
### -Disposed
62-
{{ Fill Disposed Description }}
105+
The Disposed parameter specifies whether to return disposed items instead of items pending disposition. Valid values are:
106+
107+
- $true: Return disposed items.
108+
- $false: Return items pending disposition. This is the default value.
63109
64110
```yaml
65111
Type: Boolean
@@ -75,7 +121,10 @@ Accept wildcard characters: False
75121
```
76122
77123
### -IncludeHeaders
78-
{{ Fill IncludeHeaders Description }}
124+
The IncludeHeaders parameter specifies whether headers are returned as a property with the review items. Valid values are:
125+
126+
- $true: Headers are returned as a property with the review items. This option is useful when converting the output to a PSObject in PowerShell or when exporting to CSV.
127+
- $false: Headers are not returned as a property with the review items. This is the default value.
79128
80129
```yaml
81130
Type: Boolean
@@ -91,7 +140,12 @@ Accept wildcard characters: False
91140
```
92141
93142
### -PagingCookie
94-
{{ Fill PagingCookie Description }}
143+
The PagingCookie parameter identifies the page to retrieve. This parameter is useful in the following scenarios:
144+
145+
- To avoid throttling while retrieving a large number of items.
146+
- As a method of starting where the last operation left off.
147+
148+
The PagingCookie value is returned in the PaginationCookie property each time the cmdlet is successfully run. If the PaginationCookie is blank (null), there are no more items to retrieve.
95149
96150
```yaml
97151
Type: String

0 commit comments

Comments
 (0)