Commands › Exchange Online

Set-ComplianceRetentionEventType

Exchange Online ExchangeOnlineManagement Set-*

For more information, see Security & Compliance PowerShell. Use the Set-ComplianceRetentionEventType cmdlet to modify retention event types in the Microsoft Purview compliance portal.

Quick start script

# Set-ComplianceRetentionEventType — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-ComplianceRetentionEventType
$before | Format-List

# 3. Make the change (dry run first)
Set-ComplianceRetentionEventType -Identity <ComplianceRuleIdParameter> -WhatIf
Set-ComplianceRetentionEventType -Identity <ComplianceRuleIdParameter>

# 4. Verify and diff
$after = Get-ComplianceRetentionEventType
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-ComplianceRetentionEventType -Identity <ComplianceRuleIdParameter>
 [-Comment <String>]
 [-Confirm]
 [-WhatIf]
 [<CommonParameters>]

Parameters (4)

Parameter	Type	Required	What it controls
-Identity	ComplianceRuleIdParameter	yes	The Identity parameter specifies the retention event type that you want to modify. You can use any value that uniquely identifies the retention event type. For example:
-Comment	String		The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note".
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-WhatIf	SwitchParameter		The WhatIf switch doesn't work in Security & Compliance PowerShell.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.