Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-14
Use the New-RetentionPolicy cmdlet to create a retention policy.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
New-RetentionPolicy -Name <String> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-IgnoreDehydratedFlag <SwitchParameter>] [-IsDefault
<SwitchParameter>] [-IsDefaultArbitrationMailbox
<SwitchParameter>] [-Organization
<OrganizationIdParameter>] [-RetentionId <Guid>]
[-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>]
[-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example creates the retention policy Business General without associating any retention policy tags.
 Copy Code |
|
|---|---|
New-RetentionPolicy "Business General" |
|
EXAMPLE 2
This example creates the retention policy Business General and uses the RetentionPolicyTagLinks parameter to associate two retention policy tags with this policy. You can enter multiple retention policy tags, separated by commas. If a tag name includes a space, enclose the name in quotation marks.
| Copy Code |
|
|---|---|
New-RetentionPolicy "Business General" -RetentionPolicyTagLinks "General Business","Legal" |
|
 Note: |
|---|
| The second retention tag, which is named Legal, is also enclosed in quotation marks for consistency. Values that don't include a space can be enclosed in quotation marks without any change to how the command is interpreted. |
Detailed Description
Retention policy tags are associated with a retention policy. When a retention policy is applied to a mailbox, tags associated with the policy are available to the mailbox user.
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.
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
Name |
Required |
System.String |
The Name parameter specifies the policy name. |
||
|
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 |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
||
|
IgnoreDehydratedFlag |
Optional |
System.Management.Automation.SwitchParameter |
This parameter is reserved for internal Microsoft use. |
||
|
IsDefault |
Optional |
System.Management.Automation.SwitchParameter |
The IsDefault switch configures this policy as the
default retention policy in your Exchange Online organization. The
default retention policy is applied to users who don't have a
retention policy explicitly applied (including
|
||
|
IsDefaultArbitrationMailbox |
Optional |
System.Management.Automation.SwitchParameter |
The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization.
|
||
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
||
|
RetentionId |
Optional |
System.Guid |
The RetentionId parameter specifies the identity of the retention policy to ensure mailboxes moved from an on-premises Exchange deployment to the cloud continue to have the same retention policy applied to them. The RetentionId parameter is used in cross-premises deployments. You don't need to specify this parameter in on-premises-only deployments. |
||
|
RetentionPolicyTagLinks |
Optional |
Microsoft.Exchange.Configuration.Tasks.RetentionPolicyTagIdParameter[] |
The RetentionPolicyTagLinks parameter specifies the names of retention policy tags to be associated with this 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. |
Input Types
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.
Return Types
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.