Set-UnifiedAuditLogRetentionPolicy
此 cmdlet 仅在安全与合规中心 PowerShell 内可用。 有关更多信息,请参见 安全与合规中心 PowerShell。
使用 Set-UnifiedAuditLogRetentionPolicy cmdlet 在Microsoft Defender门户或Microsoft Purview 合规门户修改审核日志保留策略。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
Set-UnifiedAuditLogRetentionPolicy
[-Identity] <PolicyIdParameter>
-Priority <Int32>
-RetentionDuration <UnifiedAuditLogRetentionDuration>
[-Confirm]
[-Description <String>]
[-Operations <MultiValuedProperty>]
[-RecordTypes <MultiValuedProperty>]
[-UserIds <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
说明
审核日志保留策略用于为管理员和用户活动生成的审核日志指定保留期。 审核日志保留策略可以根据审核的活动类型、执行活动的Microsoft 365 服务或执行活动的用户来指定保留持续时间。 有关详细信息,请参阅管理审核日志保留策略。
要在安全与合规中心 PowerShell 中使用此 cmdlet,必须分配权限。 有关详细信息,请参阅Microsoft Defender门户中的权限或Microsoft Purview 合规门户中的权限。
示例
示例 1
Set-UnifiedAuditLogRetentionPolicy -Identity "eDiscovery audit retention" -RecordTypes Discovery,AeD -UserIds admin@contoso.onmicrosoft.com -RetentionDuration SixMonths -Priority 100
本示例将电子数据展示高级事件的 AeD () 记录类型添加到策略。 它还配置该策略仅应用于仅由用户 admin@contoso.onmicrosoft.com执行的活动的审核日志。
示例 2
Set-UnifiedAuditLogRetentionPolicy -Name "SearchQueryPerformed by app@sharepoint" -Operations SearchQueryPerformed,FileAccessed -UserIds $null -RetentionDuration SixMonths -Priority 10000
此示例修改审核日志保留策略,将保留期更改为六个月,向 Operations 参数添加一个附加活动,并从 UserId 属性中删除所有值,以便策略将应用于所有用户。
参数
-Confirm
适用:安全 & 合规性
Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。
- 破坏性 cmdlet(例如 Remove-* cmdlets)内置有暂停,可强制要求先确认命令,然后再继续操作。 对于这些 cmdlet,您可以使用此确切语法跳过确认提示:
-Confirm:$false
。 - 其他大多数 cmdlet(例如 New-* 和 Set-* cmdlet)都没有内置暂停。 对于这些 cmdlet,指定不含值的 Confirm 开关会引入暂停,从而强制要求你先确认命令,然后再继续操作。
类型: | SwitchParameter |
别名: | cf |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Description
适用:安全 & 合规性
Description 参数指定审核日志保留策略的说明。 长度不得超过 256 个字符。 如果值中有空格,请使用双引号 (") 将此值括起来。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Identity
适用:安全 & 合规性
Identity 参数指定要修改的统一审核日志保留策略。 可以使用任何能够唯一标识该策略的值。 例如:
- 名称
- 可分辨名称 (DN)
- GUID
类型: | PolicyIdParameter |
Position: | 0 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-Operations
适用:安全 & 合规性
Operations 参数指定策略保留的审核日志作。 您指定的值将覆盖所有现有条目。 有关此参数的可用值的列表,请参阅 已审核的活动。
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Priority
适用:安全 & 合规性
Priority 参数指定用于确定策略处理顺序的策略的优先级值。 较高的整数值表示优先级较低。 值 1 是最高优先级,值 10000 是最低优先级。 没有两个策略可以具有相同的优先级值。
修改审核日志保留策略时,此参数是必需的,并且必须使用唯一的优先级值。
类型: | Int32 |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-RecordTypes
适用:安全 & 合规性
RecordTypes 参数指定策略保留的特定记录类型的审核日志。 有关可用值的详细信息,请参阅 AuditLogRecordType。
可以指定用逗号分隔的多个值。 您指定的值将覆盖所有现有条目。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-RetentionDuration
适用:安全 & 合规性
RetentionDuration 参数指定审核日志记录的保留时间。 有效值包含:
- ThreeMonths
- SixMonths
- NineMonths
- TwelveMonths
- TenYears
修改审核日志保留策略时,此参数是必需的。
类型: | UnifiedAuditLogRetentionDuration |
接受的值: | ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-UserIds
适用:安全 & 合规性
UserIds 参数根据执行作的用户的 ID 指定策略保留的审核日志。 您指定的值将覆盖所有现有条目。
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"
。
类型: | MultiValuedProperty |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-WhatIf
适用:安全 & 合规性
WhatIf 开关在安全与合规 PowerShell 中不起作用。
类型: | SwitchParameter |
别名: | wi |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |