Set-UnifiedAuditLogRetentionPolicy

リファレンス

モジュール:: ExchangePowerShell

適用対象:: Security & Compliance

このコマンドレットは、セキュリティ & コンプライアンス PowerShell でのみ使用できます。詳細については、「セキュリティ & コンプライアンス PowerShell」を参照してください。

Microsoft 365 Defender ポータルまたはMicrosoft Purview コンプライアンスポータルで監査ログ保持ポリシーを変更するには、Set-UnifiedAuditLogRetentionPolicy コマンドレットを使用します。

以下の構文セクションのパラメーターセットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

Set-UnifiedAuditLogRetentionPolicy
   [-Identity] <PolicyIdParameter>
   -Priority <Int32>
   -RetentionDuration <UnifiedAuditLogRetentionDuration>
   [-Confirm]
   [-Description <String>]
   [-Operations <MultiValuedProperty>]
   [-RecordTypes <MultiValuedProperty>]
   [-UserIds <MultiValuedProperty>]
   [-WhatIf]
   [<CommonParameters>]

説明

監査ログの保持ポリシーは、管理者とユーザーのアクティビティによって生成される監査ログの保持期間を指定するために使用されます。監査ログ保持ポリシーでは、監査されたアクティビティの種類、アクティビティが実行されるMicrosoft 365 サービス、またはアクティビティを実行したユーザーに基づいて、保持期間を指定できます。詳細については、「監査ログ保持ポリシーを管理する」を参照してください。

セキュリティ & コンプライアンス PowerShell でこのコマンドレットを使用するには、アクセス許可を割り当てる必要があります。詳細については、「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 (電子情報開示 Premium イベントの場合) レコードの種類をポリシーに追加します。また、ユーザーによってのみ実行されるアクティビティの監査ログにのみポリシーが適用されるように構成します admin@contoso.onmicrosoft.com。

例 2

Set-UnifiedAuditLogRetentionPolicy -Name "SearchQueryPerformed by app@sharepoint" -Operations SearchQueryPerformed,FileAccessed -UserIds $null -RetentionDuration SixMonths -Priority 10000

この例では、監査ログの保持ポリシーと保持期間の変更を 6 か月に変更し、Operations パラメーターに追加のアクティビティを追加し、すべてのユーザーにポリシーが適用されるように UserId プロパティからすべての値を削除します。

パラメーター

-Confirm

Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。

破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。これらのコマンドレットでは、正確な構文-Confirm:$falseを使用して、確認プロンプトを省略できます。
他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。これらのコマンドレットの場合、値なしで 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 パラメーターは、ポリシーによって保持される監査ログ操作を指定します。指定した値は、既存のエントリを上書きします。このパラメーターで使用可能な値の一覧については、「監査されたアクティビティ」を参照してください。

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

-Priority

Priority パラメーターは、ポリシー処理の順序を決定するポリシーの優先順位値を指定します。整数値が高いほど、優先順位が低いことを示します。値 1 が最も優先度が高く、値 10000 が最も低い優先順位です。同じ優先度の値を持つポリシーは 2 つありません。

このパラメーターは、監査ログ保持ポリシーを変更するときに必要であり、一意の優先順位の値を使用する必要があります。

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 パラメーターは、アクションを実行したユーザーの ID に基づいて、ポリシーによって保持される監査ログを指定します。指定した値は、既存のエントリを上書きします。