Set-RetentionPolicy

参考

模块:: ExchangePowerShell

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

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

使用 Set-RetentionPolicy cmdlet 可以更改现有保留策略的属性。

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

语法

Set-RetentionPolicy
   [-Identity] <MailboxPolicyIdParameter>
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Force]
   [-IsDefault]
   [-IsDefaultArbitrationMailbox]
   [-Name <String>]
   [-RetentionId <Guid>]
   [-RetentionPolicyTagLinks <RetentionPolicyTagIdParameter[]>]
   [-WhatIf]
   [<CommonParameters>]

说明

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

示例

示例 1

Set-RetentionPolicy "MyPolicy" -RetentionPolicyTagLinks "MyRetentionPolicyTag"

本示例修改策略 MyPolicy，以使保留策略标记 MyRetentionPolicyTag 与它链接。

Identity 参数是一个位置参数。可以在没有标签（标识）的情况下使用位置参数。有关位置参数的详细信息，请参阅关于参数。

参数

-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, Exchange Online Protection

-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:	MailboxPolicyIdParameter
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, Exchange Online Protection

-IsDefault

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

IsDefault 开关指定此保留策略是默认保留策略。不必为此开关指定值。

使用此开关时，会收到一条警告，指出此保留策略将替换当前默认保留策略， (IsDefault 属性值当前为 True 的策略，) 默认保留策略。默认情况下，默认保留策略名为“默认 MRM 策略”。

注意：根据所有邮箱计划中 RetentionPolicy 参数的值，更改默认保留策略可能会影响新邮箱和现有邮箱：

$null (空白) ：保留策略为默认值的更改将持续反映在新的和现有的邮箱中。
指定了保留策略：所有邮箱计划的 RetentionPolicy 参数的值应$null (空白) 或匹配配置为组织默认策略的 Exchange 保留策略。否则，在创建新邮箱、启用禁用的邮箱和更改许可证时，体验可能会不一致。有关详细信息，请参阅 Exchange Online 中的邮箱计划。

如果为邮箱分配了不是默认策略的 Exchange 保留策略，则更改许可证时将覆盖邮箱的 RetentionPolicy 值，并且需要手动重置为原始值。

如果存在数百个或数千个需要更新的邮箱，则对影响现有邮箱的默认保留策略的更改可能会使网络饱和。

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

-IsDefaultArbitrationMailbox

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

IsDefaultArbitrationMailbox 开关将此策略配置为Exchange Online组织中的仲裁邮箱的默认保留策略。不必为此开关指定值。

此参数不可用于本地部署。

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

-RetentionId

RetentionId 参数指定保留策略的标识，以确保在两个 Exchange 组织之间移动的邮箱继续应用相同的保留策略。例如，在跨林部署或跨界部署中，当邮箱从本地 Exchange 服务器移动到云，或将基于云的邮箱移动到本地 Exchange 服务器时，此参数用于确保对邮箱应用相同的保留策略。

通常不需要指定或修改保留标记的 RetentionId 参数。当使用 Import-RetentionTags.ps1 脚本导入保留标记时，系统会自动填充此参数。

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

-RetentionPolicyTagLinks

RetentionPolicyTagLinks 参数指定要与保留策略关联的保留策略标记的标识。被应用保留策略的邮箱将让保留标记与该保留策略链接。

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

-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, Exchange Online Protection

输入

Input types

若要了解此 cmdlet 接受的输入类型，请参阅 cmdlet 的输入和输出类型。如果 cmdlet 的"输入类型"字段为空，则表明此 cmdlet 不接受输入数据。

输出

Output types

若要了解此 cmdlet 接受的返回类型（亦称为"输出类型"），请参阅 cmdlet 的输入和输出类型。如果"输出类型"字段为空，则表明此 cmdlet 不返回任何数据。