Set-UnifiedAuditLogRetentionPolicy
此 Cmdlet 僅適用于安全 & 性合規性 PowerShell。 如需詳細資訊,請參閱 安全 & 性合規性 PowerShell。
使用 Set-UnifiedAuditLogRetentionPolicy Cmdlet 修改Microsoft 365 Defender入口網站或Microsoft Purview 合規性入口網站中的稽核記錄保留原則。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
Syntax
Set-UnifiedAuditLogRetentionPolicy
[-Identity] <PolicyIdParameter>
-Priority <Int32>
-RetentionDuration <UnifiedAuditLogRetentionDuration>
[-Confirm]
[-Description <String>]
[-Operations <MultiValuedProperty>]
[-RecordTypes <MultiValuedProperty>]
[-UserIds <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]
Description
稽核記錄保留原則可用來為系統管理員和使用者活動所產生的稽核記錄指定保留期間。 稽核記錄保留原則可以根據稽核的活動類型、活動執行的Microsoft 365 服務,或執行活動的使用者來指定保留期間。 如需詳細資訊,請參閱管理稽核記錄保留原則。
若要在安全 & 性合規性 PowerShell 中使用此 Cmdlet,您必須獲指派許可權。 如需詳細資訊,請參閱Microsoft 365 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-* 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 |
-Description
Description 參數會指定稽核記錄保留原則的描述。 最大長度為 256 個字元。 如果值包含空格,請使用引號 (") 括住值。
Type: | String |
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 |
-Operations
Operations 參數會指定原則所保留的稽核記錄作業。 您指定的值將會覆寫任何現有的專案。 如需此參數可用值的清單,請參閱 稽核的活動。
您可以輸入多個以逗號分隔的值。 如果值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Priority
Priority 參數會為決定原則處理順序的原則指定優先順序值。 較高的整數值表示優先順序較低。 值 1 是最高優先順序,而值 10000 是最低優先順序。 沒有兩個原則可以有相同的優先順序值。
當您修改稽核記錄保留原則,而且必須使用唯一的優先順序值時,需要此參數。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RecordTypes
RecordTypes 參數會指定原則所保留之特定記錄類型的稽核記錄。 如需可用值的詳細資訊,請參閱 AuditLogRecordType。
您可以指定多個以逗號分隔的值。 您指定的值將會覆寫任何現有的專案。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RetentionDuration
RetentionDuration 參數會指定保留稽核記錄檔記錄的時間長度。 有效值為:
- ThreeMonths
- SixMonths
- NineMonths
- TwelveMonths
- TenYears
修改稽核記錄保留原則時,需要此參數。
Type: | UnifiedAuditLogRetentionDuration |
Accepted values: | ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-UserIds
UserIds 參數會根據執行動作之使用者的識別碼,指定原則所保留的稽核記錄。 您指定的值將會覆寫任何現有的專案。
您可以輸入多個以逗號分隔的值。 如果值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
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 |