Set-RetentionPolicyTag
此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 一些参数和设置可能只适用于某个特定的环境。
使用 Set-RetentionPolicyTag cmdlet 可修改保留标记的属性。
有关保留标记的详细信息，请参阅 Exchange Server 中的保留标记和保留策略。
有关以下语法部分的参数设置的详细信息，请参阅 Exchange cmdlet 语法。
语法
Set-RetentionPolicyTag
[-Identity] <RetentionPolicyTagIdParameter>
[-AddressForJournaling <RecipientIdParameter>]
[-AgeLimitForRetention <EnhancedTimeSpan>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-JournalingEnabled <Boolean>]
[-LabelForJournaling <String>]
[-LegacyManagedFolder <ELCFolderIdParameter>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MessageClass <String>]
[-MessageFormatForJournaling <JournalingFormat>]
[-MustDisplayCommentEnabled <Boolean>]
[-Name <String>]
[-RetentionAction <RetentionAction>]
[-RetentionEnabled <Boolean>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-WhatIf]
[<CommonParameters>] Set-RetentionPolicyTag
-Mailbox <MailboxIdParameter>
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-LegacyManagedFolder <ELCFolderIdParameter>]
[-LocalizedComment <MultiValuedProperty>]
[-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
[-MustDisplayCommentEnabled <Boolean>]
[-Name <String>]
[-OptionalInMailbox <RetentionPolicyTagIdParameter[]>]
[-RetentionId <Guid>]
[-SystemTag <Boolean>]
[-WhatIf]
[<CommonParameters>] 说明
保留标记用于将邮件保留设置应用于邮箱中的文件夹和邮件。
您必须先获得权限，然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数，但如果这些参数并未包含在分配给您的权限中，那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限，请参阅 Find the permissions required to run any Exchange cmdlet。
示例
示例 1
Set-RetentionPolicyTag "AllUsers-DeletedItems" -Comment "Items in the Deleted Items folder will be automatically deleted in 120 days"本示例将更改 AllUsers-DeletedItems 保留策略标记的注释。
示例 2
Set-RetentionPolicyTag -Mailbox "Terry Adams" -OptionalInMailbox "ProjectA","ProjectB"本示例通过使用 Mailbox 和 OptionalInMailbox 参数使可选保留标记可用于用户 Terry Adams。
参数
-AddressForJournaling
此参数仅在 2010 Exchange Server可用。
保留此参数以供 Microsoft 内部使用。
| Type: | RecipientIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-AgeLimitForRetention
AgeLimitForRetention 参数指定对邮件强制执行保留的期限。 期限是从发送邮件的日期算起的天数，或者是从创建邮件的日期算起的天数（如果未发送邮件）。 如果此参数不存在且 RetentionEnabled 参数设置为 $true，则将返回错误。
| Type: | EnhancedTimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Comment
Comment 参数指定保留策略标记的注释。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Confirm
Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。
- 破坏性 cmdlet (例如，Remove-* cmdlet) 具有内置的暂停，该暂停会强制你在继续操作之前确认命令。 对于这些 cmdlet，您可以使用此确切语法跳过确认提示：
-Confirm:$false。 - 大多数其他 cmdlet (例如，New-* 和 Set-* cmdlet) 没有内置暂停。 对于这些 cmdlet，指定不含值的 Confirm 开关会引入暂停，从而强制要求你先确认命令，然后再继续操作。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DomainController
此参数只在本地 Exchange 中可用。
DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如，dc01.contoso.com。
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Force
强制开关隐藏警告或确认消息。 不必为此开关指定值。
使用此开关可在使用 RetentionId 参数时隐藏确认提示。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Identity
Identity 参数指定要修改的保留策略标记的名称、可分辨名称 (DN) 或 GUID。
| Type: | RetentionPolicyTagIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-JournalingEnabled
此参数仅在 2010 Exchange Server可用。
保留此参数以供 Microsoft 内部使用。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-LabelForJournaling
此参数仅在 2010 Exchange Server可用。
保留此参数以供 Microsoft 内部使用。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-LegacyManagedFolder
LegacyManagedFolder 参数指定托管文件夹的名称。 保留标记是使用托管文件夹的保留设置及其托管内容设置创建的。 您可以使用此参数根据现有托管文件夹创建保留标记，以将用户从托管文件夹邮箱策略迁移到保留策略。
| Type: | ELCFolderIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-LocalizedComment
LocalizedComment 参数指定保留策略标记的本地化注释和语言。 此注释根据用户的区域设置显示在 outlook Microsoft 中。
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-LocalizedRetentionPolicyTagName
LocalizedRetentionPolicyTagName 参数指定保留策略标记的本地化名称。 此名称根据用户的区域设置显示在 Outlook 中。
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Mailbox
Mailbox 参数指定用于分配选择标记的邮箱。 可以使用能够唯一标识邮箱的任意值。 例如：
- 名称
- 别名
- 可分辨名称 (DN)
- 可分辨名称 (DN)
- 域\用户名
- 电子邮件地址
- GUID
- LegacyExchangeDN
- SamAccountName
- 用户 ID 或用户主体名称 (UPN)
此参数与 OptionalInMailbox 参数必须将一起使用。
| Type: | MailboxIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-MessageClass
MessageClass 参数指定要应用标记的邮件类型。 如果未指定，则默认值设置为 *。
除了语音邮件的默认策略标记 (DPT) 外，Exchange 不支持不同邮件类型的保留标记。 仅支持 MessageClass 为 * 的标记，并且它们适用于所有消息类型。
若要创建语音邮件的 DPT，请将 MessageClass 参数设置为 voicemail，将 Type 参数设置为 All。
语音邮件的 DPT 仅适用于 Microsoft Exchange 统一消息语音邮件（通过 PR_MESSAGE_CLASS MAPI 属性值 IPM.Note.Microsoft.Voicemail* 标识）。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-MessageFormatForJournaling
此参数仅在 2010 Exchange Server可用。
保留此参数以供 Microsoft 内部使用。
| Type: | JournalingFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010 |
-MustDisplayCommentEnabled
MustDisplayCommentEnabled 参数指定是否可隐藏注释。 默认值为 $true。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Name
Name 参数指定保留策略标记的名称。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-OptionalInMailbox
OptionalInMailbox 参数与 Mailbox 参数一起使用，将个人标记分配给邮箱。 可以使用此参数向用户提供未分配给应用于指定邮箱的保留策略的个人标记。 可以指定多个以逗号分隔的个人标记。
| Type: | RetentionPolicyTagIdParameter[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RetentionAction
RetentionAction 参数指定保留策略的操作。 有效值包含:
- DeleteAndAllowRecovery：删除邮件并允许从“可恢复的项目”文件夹恢复。
- DeleteAndAllowRecovery：删除邮件并允许从“可恢复的项目”文件夹恢复。
- MoveToArchive：将邮件移动到用户的存档邮箱。 可以将此操作用于“所有”、“个人”和“可恢复项”类型的保留标记。
- PermanentlyDelete：永久删除邮件。 已永久删除的邮件无法使用“可恢复的项目”文件夹进行恢复。 除非为邮箱启用了诉讼保留，否则不会在发现搜索中返回永久删除的邮件。
MoveToDeletedItems 和 MoveToFolder 操作可用，但不起作用。 这些操作都可从邮件传递记录管理 (MRM) 1.0 （托管文件夹）升级到 MRM 2.0（保留策略）。 MRM 2.0 已在 Exchange 2010 Service Pack 1 (SP1) 中引入。
如果此参数不存在且 RetentionEnabled 参数设置为 $true，则将返回错误。
| Type: | RetentionAction |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RetentionEnabled
RetentionEnabled 参数指定是否已启用标记。 设置为 $false 时，将禁用标记，并且不会对应用标记的邮件执行保留操作。
具有禁用标记的邮件仍视为已标记，因此用户的保留策略中的任何默认策略标记都不会应用于此类邮件。
将 RetentionEnabled 参数设置为 $false 时，标记的保留期显示为“从不”。 用户可以应用此标记指示永不删除或永不移至存档的项目。 以后启用标记可能会导致意外删除或存档项目。 为了避免这种情况，如果暂时禁用保留策略，建议更改该标记的名称，以便阻止用户使用它，例如 DISABLED_<Original Name>。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RetentionId
RetentionId 参数指定备用标记 ID，以确保在将邮箱移动到另一个 Exchange 组织时（ (例如，在跨林部署或跨界部署中，当邮箱从本地 Exchange 服务器移动到云时）时，在一个 Exchange 组织中标记的邮箱项目上找到的保留标记与标记匹配， 或将基于云的邮箱移动到本地 Exchange 服务器) 。
通常，无需为保留标记指定或修改 RetentionId 参数。 在跨林或跨界部署中导入保留标记时，会自动填充此参数。
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-SystemTag
SystemTag 参数指定是否为内部 Exchange 功能创建保留策略标记。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-WhatIf
WhatIf 开关模拟命令操作。 可以使用此开关在不实际应用将会发生的更改的情况下预览这些更改。 不必为此开关指定值。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
输入
Input types
若要了解此 cmdlet 接受的输入类型，请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空，则表明此 cmdlet 不接受输入数据。
输出
Output types
若要了解此 cmdlet 接受的返回类型（亦称为"输出类型"），请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空，则表明此 cmdlet 不返回任何数据。