New-HoldComplianceRule

リファレンス

モジュール:: ExchangePowerShell

適用対象:: Security & Compliance

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

New-HoldComplianceRule コマンドレットを使用して、Microsoft Purview コンプライアンスポータルに新しい保持ルールを作成します。

注: New-HoldComplianceRule コマンドレットは、New-RetentionComplianceRule コマンドレットに置き換えられました。 New-HoldComplianceRule を使用するスクリプトがある場合は、New-RetentionComplianceRule を使用するようにスクリプトを更新します。

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

構文

New-HoldComplianceRule
   [-Name] <String>
   -Policy <PolicyIdParameter>
   [-Comment <String>]
   [-Confirm]
   [-ContentDateFrom <DateTime>]
   [-ContentDateTo <DateTime>]
   [-ContentMatchQuery <String>]
   [-Disabled <Boolean>]
   [-HoldContent <Unlimited>]
   [-HoldDurationDisplayHint <HoldDurationHint>]
   [-WhatIf]
   [<CommonParameters>]

説明

Policy パラメーターを使用して、保持ルールを既存の保持ポリシーに追加する必要があります。各保持ポリシーに追加できるルールは 1 つだけです。

セキュリティ & コンプライアンス PowerShell でこのコマンドレットを使用するには、アクセス許可を割り当てる必要があります。詳細については、「Microsoft Purview コンプライアンスセンターのアクセス許可」を参照してください。

例

例 1

New-HoldComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -ContentDateFrom "09/10/14 5:00 PM" -ContentDateTo "09/10/15 5:00 PM" -HoldContent Unlimited

次の使用例は、SeptOneYear という名前の新しい保持規則を作成し、"Internal Company Policy" という名前の既存の保持ポリシーに追加します。指定した日付の間に作成または更新されたコンテンツは無期限に保持されます。

パラメーター

-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

-ContentDateFrom

ContentDateFrom パラメーターは、含めるコンテンツの日付範囲の開始日を指定します。

コマンドを実行するコンピューターの [地域のオプション] 設定で定義されている短い日付形式を使用します。たとえば、短い日付形式 mm/dd/yyyy を使用するようにコンピューターが構成されている場合は、「09/01/2018」と入力して 2018 年 9 月 1 日を指定します。日付のみを入力したり、日付と時刻を入力することもできます。日付と時刻を入力する場合は、値を引用符 (”) で囲む必要があります (例: "09/01/2018 5:00 PM")。

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-ContentDateTo

ContentDateTo パラメーターは、含めるコンテンツの日付範囲の終了日を指定します。

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-ContentMatchQuery

ContentMatchQuery パラメーターは、コンテンツの検索フィルターを指定します。

このパラメーターには、テキストの検索文字列、またはキーワードクエリ言語 (KQL) によって書式設定されたクエリを使用します。詳細については、「キーワードクエリ言語 (KQL) 構文リファレンス」および「電子情報開示のキーワードクエリと検索条件」を参照してください。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-Disabled

Disabled パラメーターは、保持ルールを有効または無効のどちらにするかを指定します。このパラメーターの有効な入力値は、$true または $false です。既定値は $false です。

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-HoldContent

HoldContent パラメーターは、保持ルールの保持期間を指定します。有効な値は次のとおりです。

整数: 保留期間 (日数)。
無制限: コンテンツは無期限に保持されます。

Type:	Unlimited
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-HoldDurationDisplayHint

HoldDurationDisplayHint パラメーターは、Microsoft Purview コンプライアンスポータルの保持期間を表示するために使用する単位を指定します。有効な値は次のとおりです。

日数
月
年数

たとえば、このパラメーターの値が Years に設定され、HoldContent パラメーターが値 365 に設定されている場合、Microsoft Purview コンプライアンスポータルはコンテンツの保留期間として 1 年を表示します。

Type:	HoldDurationHint
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Security & Compliance

-Name

Name パラメーターは、保持ルールの一意の名前を指定します。値にスペースが含まれている場合は、値を引用符で囲んでください。

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

-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