New-RetentionComplianceRule
このコマンドレットは、セキュリティ & コンプライアンス PowerShell でのみ使用できます。 詳細については、「 セキュリティ & コンプライアンス PowerShell」を参照してください。
New-RetentionComplianceRule コマンドレットを使用して、Microsoft Purview コンプライアンス ポータルに新しい保持ルールを作成します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
New-RetentionComplianceRule
-ApplyComplianceTag <String>
-Policy <PolicyIdParameter>
[-ContentContainsSensitiveInformation <PswsHashtable[]>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-MachineLearningModelIDs <MultiValuedProperty>]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
New-RetentionComplianceRule
[-Name] <String>
-Policy <PolicyIdParameter>
[-Comment <String>]
[-ExcludedItemClasses <MultiValuedProperty>]
[-RetentionDuration <Unlimited>]
[-RetentionDurationDisplayHint <HoldDurationHint>]
[-Confirm]
[-ContentMatchQuery <String>]
[-ExpirationDateOption <String>]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
New-RetentionComplianceRule
-Policy <PolicyIdParameter>
-PublishComplianceTag <String>
[-Confirm]
[-ExpirationDateOption <String>]
[-RetentionComplianceAction <String>]
[-WhatIf]
[<CommonParameters>]
説明
Policy パラメーターを使用して、保持ルールを既存のアイテム保持ポリシーに追加する必要があります。 各アイテム保持ポリシーに追加できるルールは 1 つだけです。
セキュリティ & コンプライアンス PowerShell でこのコマンドレットを使用するには、アクセス許可を割り当てる必要があります。 詳細については、「Microsoft Purview コンプライアンス センターのアクセス許可」 を参照してください。
例
例 1
New-RetentionComplianceRule -Name InternalCompanyRule -Policy "Internal Company Policy" -RetentionDuration Unlimited
この例では、InternalCompanyRule という名前の新しいケース ホールド ルールを作成し、"内部会社ポリシー" という名前の既存のケースホールド ポリシーに追加します。 コンテンツは無期限に保持されます。
例 2
New-RetentionComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -RetentionDuration 365 -RetentionComplianceAction KeepAndDelete -ExpirationDateOption ModificationAgeInDays
この例では、SeptOneYear という名前の新しい保持ルールを作成し、"内部会社ポリシー" という名前の既存のアイテム保持ポリシーに追加します。 コンテンツは、コンテンツが削除される前に最後に変更された日から 1 年間保持されます。
パラメーター
-ApplyComplianceTag
ApplyComplianceTag パラメーターは、ルールによって電子メール メッセージまたはドキュメントに適用されるラベルを指定します (コンテンツの保持期間に影響します)。 このパラメーターの有効な値は、既存のラベルの名前です。 値にスペースが含まれている場合は、値を二重引用符で囲んでください。
Get-ComplianceTag コマンドレットと New-ComplianceTag コマンドレットを使用して、ラベルを表示、作成します。
このパラメーターは Name パラメーターや PublishComplianceTag パラメーターと併用できません。
Teams の保持ルールには、このパラメーターを使用できません。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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 スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- 破壊的なコマンドレット (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 |
-ContentContainsSensitiveInformation
ContentContainsSensitiveInformation パラメーターは、コンテンツ内の機密情報の種類の一致に基づくルールの条件を指定します。 ルールは、指定した機密情報の種類を含むコンテンツに適用されます。
このパラメーターでは、基本的な構文 を使用します @(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)
。 たとえば、「 @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})
」のように入力します。
Get-DLPSensitiveInformationType コマンドレットを使用して、組織の機密情報の種類を一覧表示します。 機密情報の種類の詳細については、「 Exchange で検索される機密情報の種類」を参照してください。
このパラメーターは ApplyComplianceTag パラメーターと併用できます。
Teams の保持ルールには、このパラメーターを使用できません。
Type: | PswsHashtable[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-ContentMatchQuery
ContentMatchQuery パラメーターは、コンテンツの検索フィルターを指定します。
このパラメーターには、テキストの検索文字列、またはキーワード クエリ言語 (KQL) によって書式設定されたクエリを使用します。 詳細については、「 キーワード クエリ言語 (KQL) 構文リファレンス」 および「 電子情報開示のキーワード クエリと検索条件」を参照してください。
Teams の保持ルールには、このパラメーターを使用できません。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-ExcludedItemClasses
ExcludedItemClasses パラメーターは、ルールから除外するメッセージの種類を指定します。 このパラメーターは、アイテムを保留ポリシーから除外する場合にのみ使用できます。これにより、指定したアイテム クラスが保留されないようにすることができます。 このパラメーターを使用しても、削除ポリシーから項目は除外されません。 通常、このパラメーターを使用して、ボイスメール メッセージ、IM 会話、およびその他のSkype for Business Online コンテンツが保留ポリシーによって保持されないようにします。 一般的なSkype for Business値は次のとおりです。
- Ipm。メモ。Microsoft。会話
- Ipm。メモ。Microsoft。Conversation.Voice
- Ipm。メモ。Microsoft。逃した
- Ipm。メモ。Microsoft。Missed.Voice
- Ipm。メモ。Microsoft。ボイスメール
- Ipm。メモ。Microsoft.VoiceMessage.UA
- Ipm。メモ。Microsoft。ボイスメール.UM
- Ipm。メモ。Microsoft.Voicemail.UM.CA
さらに、Exchange アイテムとカスタムまたはサード パーティ のメッセージ クラスの メッセージ クラスを指定できます。 指定した値は検証されないため、パラメーターは任意のテキスト値を受け入れます。
次の構文を使用して、複数の項目クラス値を指定できます。 "Value1","Value2",..."ValueN"
Teams の保持ルールには、このパラメーターを使用できません。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-ExpirationDateOption
ExpirationDateOption パラメーターは、コンテンツの作成日と最終変更日のどちらから有効期限を計算するかを指定します。 有効な値は次のとおりです。
- CreationAgeInDays
- ModificationAgeInDays
Teams の保持ルールには、このパラメーターを使用できません。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-MachineLearningModelIDs
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Name
Name パラメーターは、保持ルールの一意の名前を指定します。 値にスペースが含まれている場合は、値を引用符で囲んでください。
このパラメーターは ApplyComplianceTag パラメーターや PublishComplianceTag パラメーターと併用できません。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Policy
Policy パラメーターは、ルールを含むポリシーを指定します。
Type: | PolicyIdParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-PublishComplianceTag
PublishComplianceTag パラメーターは、ルールに対して発行されるラベルを指定します。これにより、アプリ (Outlook、SharePoint、OneDrive など) のユーザーにラベルが表示されます。 このパラメーターの有効な値は、既存のラベルの名前です。 値にスペースが含まれている場合は、値を二重引用符で囲んでください。
Get-ComplianceTag コマンドレットと New-ComplianceTag コマンドレットを使用して、ラベルを表示、作成します。
このパラメーターは、次のシナリオでは使用できません。
- Name パラメーターまたは ApplyComplianceTag パラメーターを使用します。
- Teams の保持ルールの場合。
- クラウド添付ファイル ポリシーを使用します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RetentionComplianceAction
RetentionComplianceAction パラメーターは、ルールの保持アクションを指定します。 有効な値は次のとおりです。
- Delete
- 保持
- KeepAndDelete
このパラメーターを使用しない場合、アイテム保持ポリシーは "mbx" ポリシーではなく "UniH" ポリシーとして作成されます。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RetentionDuration
RetentionDuration パラメーターは、保持ルールの保持期間を指定します。 有効な値は次のとおりです。
- 整数: 保留期間 (日数)。
- 無制限: コンテンツは無期限に保持されます。
Type: | Unlimited |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RetentionDurationDisplayHint
RetentionDurationDisplayHint パラメーターは、Microsoft Purview コンプライアンス ポータルの保持期間を表示するために使用する単位を指定します。 有効な値は次のとおりです。
- 日数
- 月
- 年数
たとえば、このパラメーターが値 Years に設定され、RetentionDuration パラメーターが値 365 に設定されている場合、Microsoft Purview コンプライアンス ポータルはコンテンツ保持期間として 1 年間表示されます。
Teams の保持ルールには、このパラメーターを使用できません。
Type: | HoldDurationHint |
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 |