Set-AppRetentionCompliancePolicy
此 cmdlet 仅在安全性 & 合规性 PowerShell 中可用。 有关详细信息,请参阅 安全性 & 合规性 PowerShell。
使用Set-AppRetentionCompliancePolicy修改应用保留符合性策略。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-AddExchangeLocation <MultiValuedProperty>]
[-AddExchangeLocationException <MultiValuedProperty>]
[-AddModernGroupLocation <MultiValuedProperty>]
[-AddModernGroupLocationException <MultiValuedProperty>]
[-Applications <String[]>]
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-PolicyRBACScopes <MultiValuedProperty>]
[-RemoveExchangeLocation <MultiValuedProperty>]
[-RemoveExchangeLocationException <MultiValuedProperty>]
[-RemoveModernGroupLocation <MultiValuedProperty>]
[-RemoveModernGroupLocationException <MultiValuedProperty>]
[-RestrictiveRetention <Boolean>]
[-WhatIf]
[<CommonParameters>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-AddAdaptiveScopeLocation <MultiValuedProperty>]
[-Applications <String[]>]
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-RemoveAdaptiveScopeLocation <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-Comment <String>]
[-Confirm]
[-Enabled <Boolean>]
[-Force]
[-WhatIf]
[<CommonParameters>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-Confirm]
[-Force]
[-WhatIf]
[<CommonParameters>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Set-AppRetentionCompliancePolicy
[-Identity] <PolicyIdParameter>
[-Confirm]
[-RetryDistribution]
[-WhatIf]
[<CommonParameters>]
说明
若要在安全性 & 合规性 PowerShell 中使用此 cmdlet,需要分配权限。 有关详细信息,请参阅 Microsoft Purview 合规门户中的权限。
示例
示例 1
Set-AppRetentionCompliancePolicy Identity "Regulation 563 Marketing" -Applications "User:MicrosoftTeams","Group:MicrosoftTeams,Yammer" -AddExchangeLocation "Scott Smith" -Comment "Added new counsel, 9/9/21"
本示例将新用户添加到为 Teams 专用频道消息设置的名为条例 563 Marketing 的现有静态范围保留策略。
参数
-AddAdaptiveScopeLocation
AddAdaptiveScopeLocation 参数指定要添加到策略的自适应范围位置。 使用 New-AdaptiveScope cmdlet 创建自适应范围。 可以使用唯一标识自适应范围的任何值。 例如:
- 名称
- 可分辨名称 (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 |
-AddExchangeLocation
当 ExchangeLocation 参数未使用值 All 时,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 |
-AddExchangeLocationException
当对 ExchangeLocation 参数使用值 All 时,AddExchangeLocationException 参数指定要添加到已排除邮箱列表的邮箱。 有效值包含:
- 此参数指定了在对 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 |
-AddModernGroupLocation
当未对 ModernGroupLocation 参数使用值 All 时,AddModernGroupLocation 参数指定要添加到包含Microsoft 365 组列表的Microsoft 365 组。
可以使用唯一标识 Microsoft 365 组的任何值。 例如:
- 名称
- 名称
- 可分辨名称 (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 |
-AddModernGroupLocationException
AddModernGroupLocationException 参数指定要在 ModernGroupLocation 参数使用值 All 时添加到已排除Microsoft 365 组列表中的Microsoft 365 组。
可以使用唯一标识 Microsoft 365 组的任何值。 例如:
- 名称
- 名称
- 可分辨名称 (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 |
-Applications
Applications 参数指定要包含的应用程序,并且仅与以下位置参数相关:
- ExchangeLocation
- ModernGroupLocation
- AdaptiveScopeLocation
此参数使用以下语法: "LocationtType:App1,LocationType:App2,...LocationType:AppN
其中 LocationType 为 User 或 Group。 例如,"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"
或 "User:MicrosoftTeams","User:Yammer"
。
Type: | String[] |
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: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-PolicyRBACScopes
{{ Fill PolicyRBACScopes Description }}
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RemoveAdaptiveScopeLocation
RemoveAdaptiveScopeLocation 参数指定要从策略中删除的自适应范围位置。 使用 New-AdaptiveScope cmdlet 创建自适应范围。 可以使用唯一标识自适应范围的任何值。 例如:
- 名称
- 可分辨名称 (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 |
-RemoveExchangeLocation
RemoveExchangeLocation 参数指定要在未对 ExchangeLocation 参数使用值 All 时从包含邮箱列表中删除的邮箱。 有效值包含:
- 此参数指定了在对 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 |
-RemoveExchangeLocationException
RemoveExchangeLocationException 参数指定要在对 ExchangeLocation 参数使用值 All 时从排除的邮箱列表中删除的邮箱。 有效值包含:
- 此参数指定了在对 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 |
-RemoveModernGroupLocation
RemoveModernGroupLocation 参数指定要在未对 ModernGroupLocation 参数使用值 All 时从包含组列表中删除的Microsoft 365 组。
可以使用唯一标识 Microsoft 365 组的任何值。 例如:
- 名称
- 名称
- 可分辨名称 (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 |
-RemoveModernGroupLocationException
RemoveModernGroupLocationException 参数指定要在 ModernGroupLocation 参数使用值 All 时从排除组列表中删除的Microsoft 365 组。
可以使用唯一标识 Microsoft 365 组的任何值。 例如:
- 名称
- 名称
- 可分辨名称 (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 |
-RestrictiveRetention
限制性Retention 参数指定是否为策略启用保留锁。 有效值包含:
- $true:为策略启用保留锁。 任何人(包括管理员)都无法关闭策略或降低其限制。
- $false:未为策略启用保留锁定。 此值为默认值。
锁定策略后,任何人都无法关闭或禁用它,或从策略中删除应用。 修改策略的唯一方法是向策略添加应用或延长其持续时间。 可以增加或扩展锁定策略,但不能减少、禁用或关闭锁定策略。
因此,在锁定策略之前,必须了解组织的合规性要求,并且不要锁定策略,直到确定它符合你的需求。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RetryDistribution
RetryDistribution 开关指定是否将策略重新分发到所有位置。 不必为此开关指定值。
成功完成初始分发的位置不包括在重试范围内。 使用此开关时,会报告策略分配错误。
注意:由于重试分发的过程是一项重大操作,因此仅在必要时运行它,一次运行一个策略。 并非每次更新策略时都会运行它。 如果运行脚本来更新多个策略,请等待策略分发成功,然后再次为下一个策略运行命令。
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 |