Export (0) Print
Expand All
Expand Minimize

Set-RetentionPolicy

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-14

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may 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 Syntax.

Set-RetentionPolicy -Identity <MailboxPolicyIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-IgnoreDehydratedFlag <SwitchParameter>] [-IsDefault <SwitchParameter>] [-IsDefaultArbitrationMailbox <SwitchParameter>] [-Name <String>] [-RetentionId <Guid>] [-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>] [-WhatIf [<SwitchParameter>]]

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

Set-RetentionPolicy "MyPolicy" -RetentionPolicyTagLinks "MyRetentionPolicyTag"
NoteNote:
The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see Parameters.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Messaging records management" entry in the Messaging policy and compliance permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The Identity parameter specifies the name, distinguished name (DN), or GUID of the retention policy.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch overrides the confirmation prompt displayed by the cmdlet when you use the RetentionId parameter.

IgnoreDehydratedFlag

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

IsDefault

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in the cloud-based service.

The IsDefault switch configures this policy as the default retention policy in your Microsoft Exchange Online organization. The default retention policy is applied to users who don't have a retention policy explicitly applied (including $null). After the user has a retention policy applied or set to $null, the default retention policy is no longer applied.

NoteNote:
This parameter isn't available in on-premises deployments.

IsDefaultArbitrationMailbox

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in the cloud-based service.

The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization.

NoteNote:
This parameter isn't available in on-premises deployments.

Name

Optional

System.String

The Name parameter specifies a unique name for the retention policy.

RetentionId

Optional

System.Guid

The RetentionId parameter specifies the identity of the retention policy to make sure mailboxes moved between two Exchange organizations continue to have the same retention policy applied to them. For example, in a cross-forest deployment or in a cross-premises deployment, when a mailbox is moved from an on-premises Exchange server to the cloud, or a cloud-based mailbox is moved to an on-premises Exchange server, this parameter is used to make sure the same retention policy is applied to the mailbox.

ImportantImportant:
It's not normally required to specify or modify the RetentionId parameter for a retention tag. The parameter is populated automatically when importing retention tags using the Import-RetentionTags.ps1 script.

RetentionPolicyTagLinks

Optional

Microsoft.Exchange.Configuration.Tasks.RetentionPolicyTagIdParameter[]

The RetentionPolicyTagLinks parameter specifies the identity of retention policy tags to associate with the retention policy. Mailboxes that get a retention policy applied have retention tags linked with that retention policy.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft