en-US

RetentionPolicy

Applies to : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Built-in security add-on for on-premises mailboxes

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

Use the Set-RetentionPolicy cmdlet to change the properties of an existing retention policy.

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

You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't 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.

Available cmdlets

Parameters

Name Type Default value Accepted values
IsDefault SwitchParameter
IsDefaultArbitrationMailbox SwitchParameter
Name String
RetentionId Guid
RetentionPolicyTagLinks RetentionPolicyTagIdParameter[]

Examples

Example 1

Set-RetentionPolicy "MyPolicy" -RetentionPolicyTagLinks "MyRetentionPolicyTag"

This example modifies the policy MyPolicy to link the retention policy tag MyRetentionPolicyTag with it.

The Identity parameter is positional, which means you can use it without the -Identity label in the supported location in the command (in this case, first). For more information about positional parameters, see About Parameters.

Microsoft Learn documentation