Commands › Exchange Online

New-ComplianceRetentionEventType

Exchange Online ExchangeOnlineManagement New-*

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

Quick start script

# New-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)
New-ComplianceRetentionEventType -Name <String> -WhatIf
New-ComplianceRetentionEventType -Name <String>

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

Syntax

New-ComplianceRetentionEventType -Name <String>
 [-Comment <String>]
 [-Confirm]
 [-WhatIf]
 [<CommonParameters>]

Parameters (4)

ParameterTypeRequiredWhat it controls
-Name String yes The Name parameter specifies the unique name of the retention event type. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks.
-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.