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

Get-RetentionPolicyTag

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

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


Get-RetentionPolicyTag [-Identity <RetentionPolicyTagIdParameter>] [-DomainController <Fqdn>] [-IncludeSystemTags <SwitchParameter>] [-Organization <OrganizationIdParameter>]


Get-RetentionPolicyTag [-DomainController <Fqdn>] [-IncludeSystemTags <SwitchParameter>] [-Mailbox <MailboxIdParameter>] [-OptionalInMailbox <SwitchParameter>] [-Organization <OrganizationIdParameter>]

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.

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.

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.

Error Description

 

 

This example returns all retention policy 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"
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.