Get-RetentionPolicyTag
此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 某些参数和设置可能只属于一个环境或另一个环境。
使用 Get-RetentionPolicyTag cmdlet 可以检索保留标记的设置。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
Identity
Get-RetentionPolicyTag
[[-Identity] <RetentionPolicyTagIdParameter>]
[-DomainController <Fqdn>]
[-IncludeSystemTags]
[-Types <ElcFolderType[]>]
[<CommonParameters>]
Mailbox
Get-RetentionPolicyTag
[-Mailbox <MailboxIdParameter>]
[-OptionalInMailbox]
[-DomainController <Fqdn>]
[-IncludeSystemTags]
[-Types <ElcFolderType[]>]
[<CommonParameters>]
说明
保留标记用于将邮件保留设置应用于邮件或文件夹。 保留标记有三种类型:
- 保留策略标记
- 默认策略标记
- Personal 标记
保留策略标记应用于默认文件夹(如收件箱和已删除邮件)。 Personal 标记可供用户使用以标记项目和文件夹。 默认策略标记应用于不具有由用户应用的标记的所有项目,或不是从其所在文件夹继承的所有项目。 Get-RetentionPolicyTag cmdlet 显示指定标记的所有设置。
您必须先获得权限,然后才能运行此 cmdlet。 尽管本文列出了 cmdlet 的所有参数,但如果某些参数未包含在分配给你的权限中,则可能无法访问这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet。
示例
示例 1
Get-RetentionPolicyTag
本示例返回所有保留标记。
示例 2
Get-RetentionPolicyTag -IncludeSystemTags
除了个人和默认标记以外,本示例还将返回系统标记。
示例 3
Get-RetentionPolicyTag "Consolidated Messenger"
本示例返回标记 Consolidated Messenger 的设置。
示例 4
Get-RetentionPolicyTag -Types Inbox,All | Format-Table Name,Type,RetentionEnabled,AgeLimitForRetention,RetentionAction -AutoSize
此示例返回“收件箱”和“所有类型”的所有保留标记,并将结果传递给 Format-Table 命令,以显示 Name、Type、RetentionEnabled、AgeLimitForRetention 和 RetentionAction 属性。
参数
-DomainController
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
此参数只在本地 Exchange 中可用。
DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如,dc01.contoso.com。
参数属性
| 类型: | Fqdn |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Identity
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online
Identity 参数指定标记的名称。
参数属性
| 类型: | RetentionPolicyTagIdParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
Identity
| Position: | 1 |
| 必需: | False |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-IncludeSystemTags
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online
IncludeSystemTags 开关指定是否返回任何系统标记。 不必为此开关指定值。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Mailbox
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online
Mailbox 参数返回分配给应用于指定邮箱的保留策略的保留标记。 可以使用能够唯一标识邮箱的任意值。 例如:
- 名称
- 别名
- 可分辨名称 (DN)
- 可分辨名称 (DN)
- 域\用户名
- 电子邮件地址
- GUID
- LegacyExchangeDN
- SamAccountName
- 用户 ID 或用户主体名称 (UPN)
此参数仅返回默认策略标记 (DCT) 和个人标记;它不返回保留策略标记。
参数属性
| 类型: | MailboxIdParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
Mailbox
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-OptionalInMailbox
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online
OptionalInMailbox 参数与 Mailbox 参数一起使用,以返回分配给指定邮箱的任何选择加入保留标记。 不必为此开关指定值。
选择加入保留标记是使用 Set-RetentionPolicyTag -Mailbox -OptionalInMailbox 命令显式分配给邮箱的个人标记。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
Mailbox
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Types
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online
Types 参数指定要返回的保留标记的类型。 有效值包括:
- 日历
- 联系人
- DeletedItems
- 草稿
- Inbox
- JunkEmail
- 日志
- 注意
- 发件箱
- SentItems
- 任务
- 全部
- RssSubscriptions
- ConversationHistory
- 个人
此参数接受用逗号分隔的多个值。
参数属性
| 类型: | ElcFolderType[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输入
Input types
若要了解此 cmdlet 接受的输入类型,请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空,则表明此 cmdlet 不接受输入数据。
输出
Output types
若要了解此 cmdlet 接受的返回类型(亦称为"输出类型"),请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空,则表明此 cmdlet 不返回任何数据。