Get-RetentionPolicyTag
Syntax
Get-RetentionPolicyTag
[[-Identity] <RetentionPolicyTagIdParameter>]
[-DomainController <Fqdn>]
[-IncludeSystemTags]
[-Types <ElcFolderType[]>]
[<CommonParameters>]
Get-RetentionPolicyTag
[-DomainController <Fqdn>]
[-IncludeSystemTags]
[-Mailbox <MailboxIdParameter>]
[-OptionalInMailbox]
[-Types <ElcFolderType[]>]
[<CommonParameters>]
Description
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 this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).
Examples
-------------------------- Example 1 --------------------------
Get-RetentionPolicyTag
This example returns all retention tags.
-------------------------- Example 2 --------------------------
Get-RetentionPolicyTag -IncludeSystemTags
This example returns system tags in addition to personal and default tags.
-------------------------- Example 3 --------------------------
Get-RetentionPolicyTag "Consolidated Messenger"
This example returns the settings for the tag Consolidated Messenger.
-------------------------- Example 4 --------------------------
Get-RetentionPolicyTag -Types Inbox,All | Format-Table Name,Type,RetentionEnabled,AgeLimitForRetention,RetentionAction -AutoSize
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.
Optional Parameters
This parameter is available only in on-premises Exchange.
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
Type: | Fqdn |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 |
The Identity parameter specifies the name of the tag.
Type: | RetentionPolicyTagIdParameter |
Position: | 1 |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 |
The IncludeSystemTags switch specifies whether to return any system tags.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 |
The Mailbox parameter isn't available in this release.
Type: | MailboxIdParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 |
The OptionalInMailbox parameter isn't available in this release.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 |
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.
Type: | ElcFolderType[] |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 |
Inputs
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.
Outputs
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.