Skip to content

Commit 748eecf

Browse files
authored
Update Get-ReviewItems.md
1 parent 70e3e36 commit 748eecf

File tree

1 file changed

+35
-17
lines changed

1 file changed

+35
-17
lines changed

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

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

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.
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.
1818

1919
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).
2020

@@ -33,34 +33,39 @@ Get-ReviewItems -TargetLabelId <String>
3333
## DESCRIPTION
3434
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).
3535

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).
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).
3737

3838
## EXAMPLES
3939

4040
### Example 1
4141

4242
```powershell
4343
$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true
44+
4445
$formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers
46+
4547
$formattedExportItems
4648
```
4749

48-
Retrieves the first page of items pending disposition for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. The results will be converted to PSObject types objects for each item, and then output to the screen.
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.
4951

5052
### Example 2
5153

5254
```powershell
5355
$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -Disposed $true
56+
5457
$formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers
55-
$formattedExportItems | Select Subject, Location, ReviewAction, Comment, DeletedBy, DeletedDate
58+
59+
$formattedExportItems | Select Subject,Location,ReviewAction,Comment,DeletedBy,DeletedDate
5660
```
5761

58-
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.
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.
5963

6064
### Example 3
6165

6266
```powershell
6367
$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true
68+
6469
$exportItems = $itemsPendingDisposition.ExportItems
6570
6671
While (![string]::IsNullOrEmpty($itemsPendingDisposition.PaginationCookie))
@@ -72,21 +77,16 @@ While (![string]::IsNullOrEmpty($itemsPendingDisposition.PaginationCookie))
7277
$exportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers | Export-Csv C:\temp\ItemsPendingDisposition.csv -NoTypeInformation
7378
```
7479

75-
Retrieves all items pending disposition for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. If multiple pages of items exist, it will continue until no more pages exist. The results will be exported to a CSV file.
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.
7681

77-
> [!NOTE]
78-
> While this cmdlet does not impose any limit to the number of items/pages that can be retrieved, other throttling may occur. For retrieving a large number of items, it is recommended to include breaks in your script to prevent throttling. The PagingCookie parameter can be used to pick up where the script left off after a break.
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.
7983

8084
## PARAMETERS
8185

8286
### -TargetLabelId
83-
The TargetLabelId parameter specifies the immutable ID of the label that you want to retrieve review items for.
84-
85-
To get the immutable ID for a particular label, you can use Exchange Online PowerShell:
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.
8688

87-
```powershell
88-
Get-ComplianceTag <RetentionLabelName> | select ImmutableId
89-
```
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`.
9090

9191
```yaml
9292
Type: String
@@ -102,7 +102,10 @@ Accept wildcard characters: False
102102
```
103103
104104
### -Disposed
105-
Use the Disposed parameter to specify whether you want the cmdlet to return disposed items instead of items pending disposition.
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.
106109
107110
```yaml
108111
Type: Boolean
@@ -118,7 +121,10 @@ Accept wildcard characters: False
118121
```
119122
120123
### -IncludeHeaders
121-
Use the IncludeHeaders parameter to specify whether you want headers to be returned as a property with the review items. These will be useful when converting to PSObject in PowerShell, or when exporting to CSV.
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.
122128
123129
```yaml
124130
Type: Boolean
@@ -134,7 +140,12 @@ Accept wildcard characters: False
134140
```
135141
136142
### -PagingCookie
137-
Use the PagingCookie parameter to identify which page to retrieve. This is useful when a large number of items must be retrieved or as a method of starting where the last operation left off. The value for PagingCookie is returned in the PaginationCookie property each time the cmdlet is successfully run. If the PaginationCookie is null, there are no more items to retrieve.
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.
138149
139150
```yaml
140151
Type: String
@@ -152,3 +163,10 @@ Accept wildcard characters: False
152163
### CommonParameters
153164
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
154165
166+
## INPUTS
167+
168+
## OUTPUTS
169+
170+
## NOTES
171+
172+
## RELATED LINKS

0 commit comments

Comments
 (0)