Get-ComplianceRetentionEventType

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-ComplianceRetentionEventType cmdlet to view retention event types in the Microsoft Purview compliance portal.

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

Syntax

Get-ComplianceRetentionEventType
   [-Identity <ComplianceRuleIdParameter>]
   [-LoadTag]
   [<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-ComplianceRetentionEventType | Format-Table Name,Priority

This example returns a summary list of all retention event types

Example 2

Get-ComplianceRetentionEventType -Identity "Fabrikam Project" -LoadTag

This example returns detailed information for the retention event type named Fabrikam Project, including the associated compliance tags.

Parameters

-Identity

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

• Name
• Distinguished name (DN)
• GUID

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

-LoadTag

The LoadTag switch specifies whether to show the compliance tags that are associated with the retention event types. You don't need to specify a value with this switch.

If you don't use this switch, the ComplianceTag property will always appear empty in the results.

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