New-RetentionPolicyTag

参考

模块:: ExchangePowerShell

适用于:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

此 cmdlet 可在本地 Exchange 和基于云的服务中使用。一些参数和设置可能只适用于某个特定的环境。

使用 New-RetentionPolicyTag cmdlet 可以创建保留标记。

有关保留标记的详细信息，请参阅 Exchange Server 中的保留标记和保留策略。

有关以下语法部分的参数设置的详细信息，请参阅 Exchange cmdlet 语法。

语法

New-RetentionPolicyTag
   [-Name] <String>
   [-AddressForJournaling <RecipientIdParameter>]
   [-AgeLimitForRetention <EnhancedTimeSpan>]
   [-Comment <String>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-IsDefaultAutoGroupPolicyTag]
   [-IsDefaultModeratedRecipientsPolicyTag]
   [-JournalingEnabled <Boolean>]
   [-LabelForJournaling <String>]
   [-LocalizedComment <MultiValuedProperty>]
   [-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
   [-MessageClass <String>]
   [-MessageFormatForJournaling <JournalingFormat>]
   [-MustDisplayCommentEnabled <Boolean>]
   [-RetentionAction <RetentionAction>]
   [-RetentionEnabled <Boolean>]
   [-RetentionId <Guid>]
   [-SystemTag <Boolean>]
   [-Type <ElcFolderType>]
   [-WhatIf]
   [<CommonParameters>]

New-RetentionPolicyTag
   [-Name] <String>
   [-ManagedFolderToUpgrade <ELCFolderIdParameter>]
   [-Comment <String>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-IsDefaultAutoGroupPolicyTag]
   [-IsDefaultModeratedRecipientsPolicyTag]
   [-LocalizedComment <MultiValuedProperty>]
   [-LocalizedRetentionPolicyTagName <MultiValuedProperty>]
   [-MustDisplayCommentEnabled <Boolean>]
   [-SystemTag <Boolean>]
   [-Type <ElcFolderType>]
   [-WhatIf]
   [<CommonParameters>]

说明

保留标记用于将邮件保留设置应用于邮箱中的文件夹和邮件。

保留标记支持以本地化语言显示标记名称和可选注释。来自 CultureInfo 类的语言区域性代码用于达到此目的。

您必须先获得权限，然后才能运行此 cmdlet。虽然本主题中列出了此 cmdlet 的所有参数，但如果这些参数并未包含在分配给您的权限中，那么您将无法使用这些参数。若要查找在贵组织中运行任何 cmdlet 或参数所需的权限，请参阅 Find the permissions required to run any Exchange cmdlet。

示例

示例 1

New-RetentionPolicyTag "Finance-DeletedItems" -Type DeletedItems -RetentionEnabled $true -AgeLimitForRetention 30 -RetentionAction PermanentlyDelete

本示例为“已删除邮件”默认文件夹创建保留策略标记 Finance-DeletedItems。将该标记作为保留策略的一部分应用于邮箱时，它将在 30 天后永久删除“已删除邮件”文件夹中的所有类型的邮件。

示例 2

New-RetentionPolicyTag "Finance-Default" -Type All -RetentionEnabled $true -AgeLimitForRetention 365 -RetentionAction PermanentlyDelete

本示例创建默认策略标记 Finance-Default。将该标记作为保留策略的一部分应用于邮箱时，它将在 365 天内永久删除没有保留标记的所有邮件。类似语音邮件这样的存在其默认标记（类型为 All 的保留标记）的特定邮件类的邮件不会受影响。

示例 3

New-RetentionPolicyTag "Business Critical" -Type Personal -Comment "Use this tag for all business critical mail" -RetentionEnabled $true -AgeLimitForRetention 2556 -RetentionAction PermanentlyDelete

本示例创建类型为 Personal 的保留标记 Business Critical。将该标记作为保留策略的一部分应用于邮箱邮件时，将在大约 7 年后永久删除这些邮件。

参数

-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

-IsDefaultAutoGroupPolicyTag

此参数仅在基于云的服务中可用。

保留此参数以供 Microsoft 内部使用。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-IsDefaultModeratedRecipientsPolicyTag

此参数仅在基于云的服务中可用。

保留此参数以供 Microsoft 内部使用。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	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

-LocalizedComment

LocalizedComment 参数指定本地化的注释及其语言。当用户的语言设置与为此参数指定的语言匹配时，Microsoft Outlook 和 Outlook 网页版显示相应的本地化注释。应以 ISO 语言代码:注释的格式指定注释，例如 LocalizedComment EN-US:"This is a localized comment in U.S. English"。

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 和 Outlook 网页版显示相应的本地化标记名称。应以 ISO 语言代码:名称的格式指定名称，例如 LocalizedRetentionPolicyTagName EN-US:"Business Critical"。

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

-ManagedFolderToUpgrade

此参数只在本地 Exchange 中可用。

ManagedFolderToUpgrade 参数指定要用作保留标记的模板的托管文件夹的名称。

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

-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:	1
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

-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 服务器时，在云中标记的邮箱项目与标记匹配。此参数用于跨内部部署。不需要在仅内部部署中指定此参数。

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

-Type

Type 参数指定正在创建的保留标记的类型。有效值包括：

全部
存档
日历
待筛选：仅在 Exchange Online 中可用。
联系人
ConversationHistory
DeletedItems
草稿
Inbox
日志
JunkEmail
LegacyArchiveJournals
ManagedCustomFolder
注意
发件箱
个人
RecoverableItems
RssSubscriptions
SentItems
SyncIssues
任务

要创建默认策略标记 (DPT)，请指定类型 All。对于类型为 RecoverableItems 的标记，唯一有效的保留操作为 MoveToArchive。

Type:	ElcFolderType
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 不返回任何数据。

New-RetentionPolicyTag

语法

说明

示例

示例 1

示例 2

示例 3

参数

-AddressForJournaling

-AgeLimitForRetention

-Comment

-Confirm

-DomainController

-IsDefaultAutoGroupPolicyTag

-IsDefaultModeratedRecipientsPolicyTag

-JournalingEnabled

-LabelForJournaling

-LocalizedComment

-LocalizedRetentionPolicyTagName

-ManagedFolderToUpgrade

-MessageClass

-MessageFormatForJournaling

-MustDisplayCommentEnabled

-Name

-RetentionAction

-RetentionEnabled

-RetentionId

-SystemTag

-Type

-WhatIf

输入

输出

反馈

反馈

其他资源