Get-RetentionEvent

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-RetentionEvent cmdlet to view retention events in your organization.

Note: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see Connect to Exchange Online PowerShell.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Get-RetentionEvent
   [[-Identity] <EwsStoreObjectIdParameter>]
   [-AllStatus]
   [<CommonParameters>]

Description

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.

Examples

Example 1

Get-RetentionEvent

This example returns a summary list of all retention events.

Example 2

Get-RetentionEvent -Identity x | Format-List

This example returns detailed information about retention the specified retention event.

Parameters

-AllStatus

The AllStatus switch specifies whether to include zero count events in the results. You don't need to specify a value with this switch.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-Identity

The Identity parameter specifies the retention event that you want to view.

Type:EwsStoreObjectIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Online

Inputs

Outputs