Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-RetentionPolicyTag

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2012-09-17

Use the Get-RetentionPolicyTag cmdlet to retrieve settings for a retention tag.

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

Get-RetentionPolicyTag [-Mailbox <MailboxIdParameter>] [-OptionalInMailbox <SwitchParameter>] <COMMON PARAMETERS>
Get-RetentionPolicyTag [-Identity <RetentionPolicyTagIdParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-DomainController <Fqdn>] [-IgnoreDehydratedFlag <SwitchParameter>] [-IncludeSystemTags <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-Types <ElcFolderType[]>]

This example returns all retention tags.

Get-RetentionPolicyTag

This example returns system tags in addition to personal and default tags.

Get-RetentionPolicyTag -IncludeSystemTags

This example returns the settings for the tag Consolidated Messenger.

Get-RetentionPolicyTag "Consolidated Messenger"

This example returns all retention tags of Inbox and All types and pipes the results to the Format-Table command to display the Name, Type, RetentionEnabled, AgeLimitForRetention, and RetentionAction properties.

Get-RetentionPolicyTag -Types Inbox,All | Format-Table Name,Type,RetentionEnabled,AgeLimitForRetention,RetentionAction -AutoSize

Retention tags are used to apply message retention settings to messages or folders. There are three types of retention tags:

  • Retention policy tags

  • Default policy tags

  • Personal tags

Retention policy tags are applied to default folders such as Inbox and Deleted Items. Personal tags are available to users to tag items and folders. The default policy tag is applied to all items that don't have a tag applied by the user or aren't inherited from the folder they're located in. The Get-RetentionPolicyTag cmdlet displays all the settings for the specified tag.

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

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.RetentionPolicyTagIdParameter

The Identity parameter specifies the name of the tag.

IgnoreDehydratedFlag

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

IncludeSystemTags

Optional

System.Management.Automation.SwitchParameter

The IncludeSystemTags switch specifies whether to return any system tags.

Mailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Mailbox parameter isn't available in this release.

OptionalInMailbox

Optional

System.Management.Automation.SwitchParameter

The OptionalInMailbox parameter isn't available in this release.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

Types

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ElcFolderType[]

The Types parameter specifies the type of retention tag to return. Valid values include:

  • Calendar

  • Contacts

  • DeletedItems

  • Drafts

  • Inbox

  • JunkEmail

  • Journal

  • Notes

  • Outbox

  • SentItems

  • Tasks

  • All

  • RssSubscriptions

  • ConversationHistory

  • Personal

The parameter accepts multiple values separated by a comma.

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.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.