Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-18
Use the Get-RetentionPolicy cmdlet to retrieve the settings for retention policies.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-RetentionPolicy [-Identity
<MailboxPolicyIdParameter>] [-DomainController <Fqdn>]
[-IgnoreDehydratedFlag <SwitchParameter>] [-Organization
<OrganizationIdParameter>]
|
Examples
EXAMPLE1
This example returns all the properties of the retention policy RP Finance. The output is piped to the Format-List cmdlet to format the results as a list of properties.
 Copy Code |
|
|---|---|
Get-RetentionPolicy -Identity "RP Finance" | Format-List |
|
Detailed Description
A retention policy is associated with a group of retention policy tags that specify retention settings for items in a mailbox. A policy may contain one default policy tag to move items to an archive mailbox, one default policy tag to delete all items, one default policy tag to delete voicemail items, and multiple personal tags to move or delete items. A mailbox can have only one retention policy applied to it. The Get-RetentionPolicy cmdlet displays all policy settings associated with the specified policy.
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 |
|---|---|---|---|
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. |
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter |
The Identity parameter specifies the policy name. |
|
IgnoreDehydratedFlag |
Optional |
System.Management.Automation.SwitchParameter |
This parameter is reserved for internal Microsoft use. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
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.