Set-HoldCompliancePolicy
此 cmdlet 仅在安全性 & 合规性 PowerShell 中可用。 有关详细信息,请参阅 安全性 & 合规性 PowerShell。
使用 Set-HoldCompliancePolicy cmdlet 修改Microsoft Purview 合规门户中的现有保留策略。
注意:Set-HoldCompliancePolicy cmdlet 已替换为 Set-RetentionCompliancePolicy cmdlet。 如果你有使用 Set-HoldCompliancePolicy 的脚本,请将其更新为使用 Set-RetentionCompliancePolicy。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
Set-HoldCompliancePolicy
[-Identity] <PolicyIdParameter>
[-RetryDistribution]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Set-HoldCompliancePolicy
[-Identity] <PolicyIdParameter>
[-AddExchangeLocation <MultiValuedProperty>]
[-AddPublicFolderLocation <MultiValuedProperty>]
[-AddSharePointLocation <MultiValuedProperty>]
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-RemoveExchangeLocation <MultiValuedProperty>]
[-RemovePublicFolderLocation <MultiValuedProperty>]
[-RemoveSharePointLocation <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
说明
若要在安全性 & 合规性 PowerShell 中使用此 cmdlet,需要分配权限。 有关详细信息,请参阅 Microsoft Purview 合规门户中的权限。
注意:在添加或删除范围位置时,请勿使用管道Foreach-Object命令: "Value1","Value2",..."ValueN" | Foreach-Object {Set-HoldCompliancePolicy -Identity "Regulation 123 Compliance" -RemoveExchangeLocation $_}
。
示例
示例 1
Set-HoldCompliancePolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "Kitty Petersen" -AddSharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" -RemovePublicFolderLocation All -Comment "Added new counsel, 9/9/14"
本示例对名为“法规 123 遵从性”的现有保留策略进行以下更改:
- 为名为“Kitty Petersen”的用户添加邮箱。
- 添加 SharePoint Online 网站
https://contoso.sharepoint.com/sites/teams/finance
。 - 删除公用文件夹。
- 更新注释。
参数
-AddExchangeLocation
AddExchangeLocation 参数指定要添加到包含邮箱列表的邮箱。 有效值包含:
- ExchangeLocation 参数指定了要添加到策略中的邮箱。有效值为:
- 邮箱
所有邮箱的值 All。 只能使用此值本身。
- 名称
- 名称
- 可分辨名称 (DN)
- GUID
Update 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"
。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-AddPublicFolderLocation
AddPublicFolderLocation 参数指定您要将所有公用文件夹添加到保留策略中。 可以对此参数使用值 All。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-AddSharePointLocation
AddSharePointLocation 参数指定要在未对 SharePointLocation 参数使用值 All 时添加到包含网站列表的 SharePoint Online 网站。 可以按 URL 值标识网站。
Update 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"
。
在为 SharePoint Online 网站编制索引之前,无法将其添加到策略。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Comment
Comment 参数指定可选注释。 如果您指定包含空格的值,为该值加上双引号("),例如:"这是管理员备注"。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-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: | Security & Compliance |
-Enabled
Enabled 参数指定是否已启用此策略。 有效值包含:
- $true:策略已启用。 此值为默认值。
- $true:启用此策略。此为默认值。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Force
强制开关隐藏警告或确认消息。 不必为此开关指定值。
您可以在以编程方式运行任务时使用此开关,因为此时并不适合提示用户提供管理输入。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Identity
Identity 参数指定要修改的保留策略。 可以使用任何能够唯一标识该策略的值。 例如:
- 名称
- 可分辨名称 (DN)
- GUID
Type: | PolicyIdParameter |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RemoveExchangeLocation
RemoveExchangeLocation 参数指定要从策略中删除的现有邮箱。 有效值包含:
- 此参数指定了在对 ExchangeLocation 参数使用值 All 时要从已排除邮箱列表中删除的邮箱。有效值为:
- 邮箱
所有邮箱的值 All。 只能使用此值本身。
- 名称
- 名称
- 可分辨名称 (DN)
- GUID
Update 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"
。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RemovePublicFolderLocation
RemovePublicFolderLocation 参数指定您要从保留策略中删除所有公用文件夹。 可以对此参数使用值 All。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RemoveSharePointLocation
RemoveSharePointLocation 参数指定要在未对 SharePointLocation 参数使用值 All 时从包含网站列表中删除的 SharePoint Online 网站。 可以按 URL 值标识网站。
Update 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"
。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RetryDistribution
RetryDistribution 开关指定是否将策略重新分发到所有Exchange Online和 SharePoint Online 位置。 不必为此开关指定值。
成功完成初始分发的位置不包括在重试范围内。 使用此开关时,会报告策略分配错误。
注意:由于重试分发的过程是一项重大操作,因此仅在必要时运行它,一次运行一个策略。 并非每次更新策略时都会运行它。 如果运行脚本来更新多个策略,请等待策略分发成功,然后再次为下一个策略运行命令。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-WhatIf
WhatIf 开关在安全 & 合规性 PowerShell 中不起作用。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |