Get-ComplianceRetentionEvent

Module:

ExchangePowerShell

Applies to:

Security & Compliance

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-ComplianceRetentionEvent cmdlet to view compliance retention events in the Microsoft Purview compliance portal.

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

Syntax

Get-ComplianceRetentionEvent
   [-Identity <PolicyIdParameter>]
   [-BeginDateTime <System.DateTime>]
   [-DomainController <Fqdn>]
   [-EndDateTime <System.DateTime>]
   [-PreviewOnly]
   [<CommonParameters>]

Description

To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see Permissions in the Microsoft Purview compliance portal.

Examples

Example 1

Get-ComplianceRetentionEvent | Format-Table Name,Description

The example returns a summary list of all compliance retention events.

Example 2

Get-ComplianceRetentionEvent -Identity "Case 1234"

This example returns detailed information about the compliance retention event named Case 1234.

Parameters

-BeginDateTime

{{ Fill BeginDateTime Description }}

Type:	System.DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-DomainController

This parameter is reserved for internal Microsoft use.

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-EndDateTime

{{ Fill EndDateTime Description }}

Type:	System.DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-Identity

The Identity parameter specifies the compliance retention event that you want to view. You can use any value that uniquely identifies the event. For example:

• Name
• Distinguished name (DN)
• GUID

Type:	PolicyIdParameter
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Security & Compliance

-PreviewOnly

{{ Fill PreviewOnly Description }}

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance