New-ComplianceSearchAction
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。
New-ComplianceSearchAction コマンドレットを使用して、Exchange ServerとMicrosoft Purview コンプライアンス ポータルでコンテンツ検索のアクションを作成します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
New-ComplianceSearchAction
[-SearchName] <String[]>
[-Export]
[-ActionName <String>]
[-ArchiveFormat <ComplianceExportArchiveFormat>]
[-Confirm]
[-FileTypeExclusionsForUnindexedItems <String[]>]
[-EnableDedupe <Boolean>]
[-ExchangeArchiveFormat <ComplianceExportArchiveFormat>]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-IncludeSharePointDocumentVersions <Boolean>]
[-JobOptions <Int32>]
[-NotifyEmail <String>]
[-NotifyEmailCC <String>]
[-ReferenceActionName <String>]
[-Region <String>]
[-Report]
[-RetentionReport]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-Scope <ComplianceExportScope>]
[-SearchNames <String[]>]
[-SharePointArchiveFormat <ComplianceExportArchiveFormat>]
[-ShareRootPath <String>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>] New-ComplianceSearchAction
[-SearchName] <String[]>
[-Preview]
[-ActionName <String>]
[-Confirm]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-JobOptions <Int32>]
[-ReferenceActionName <String>]
[-Region <String>]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-SearchNames <String[]>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>] New-ComplianceSearchAction
[-SearchName] <String[]>
[-Purge]
[-PurgeType <ComplianceDestroyType>]
[-ActionName <String>]
[-Confirm]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-JobOptions <Int32>]
[-Region <String>]
[-ReferenceActionName <String>]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-SearchNames <String[]>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>] 説明
New-ComplianceSearch コマンドレットを使用してコンテンツ検索を作成し、Start-ComplianceSearch コマンドレットを使用して実行した後、New-ComplianceSearchAction コマンドレットを使用して検索アクションを検索に割り当てます。
オンプレミスの Exchange では、このコマンドレットはメールボックス検索ロールで使用できます。 既定では、このロールは Discovery Management ロール グループにのみ割り当てられます。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
Microsoft 365 では、このコマンドレットの実行に使用するアカウントに、有効な Microsoft 365 ライセンスが割り当てられている必要があります。
セキュリティ & コンプライアンス PowerShell でこのコマンドレットを使用するには、アクセス許可を割り当てる必要があります。 詳細については、「Microsoft Purview コンプライアンス センターのアクセス許可」 を参照してください。
例
例 1
New-ComplianceSearchAction -SearchName "Project X" -Preview次の使用例は、Project X という名前のコンテンツ検索のプレビュー検索アクションを作成します。
例 2
New-ComplianceSearchAction -SearchName "Project X" -Export次の使用例は、Project X という名前のコンテンツ検索のエクスポート検索アクションを作成します。
例 3
New-ComplianceSearchAction -SearchName "Remove Phishing Message" -Purge -PurgeType SoftDelete次の使用例は、フィッシング メッセージの削除という名前のコンテンツ検索によって返される検索結果を削除します。 Purge パラメーターを使用すると、インデックスのないアイテムが削除されないことに注意してください。
例 4
New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip -ExchangeArchiveFormat PerUserPst次の使用例は、"Case 321 All Sites" という名前のコンテンツ検索によって返される結果をエクスポートします。 検索結果は圧縮され、1 つの ZIP ファイルにエクスポートされます。 検索に Exchange の場所が含まれている場合、検索結果はメールボックスごとに 1 つの PST ファイルとしてエクスポートされます。
パラメーター
-ActionName
このパラメーターは、クラウドベースのサービスでのみ使用できます。
ActionName パラメーターは、コンテンツ検索アクションの名前を指定します。 このパラメーターは、SearchName パラメーターで複数のコンテンツ検索を指定する場合にのみ使用します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-ArchiveFormat
このパラメーターは非推奨で、もう使用されていません。
Exchange 検索結果の形式を指定するには、ExchangeArchiveFormat パラメーターを使用します。 SharePoint 検索結果と OneDrive 検索結果の形式を指定するには、SharePointArchiveFormat パラメーターを使用します。
| Type: | ComplianceExportArchiveFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, 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: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-EnableDedupe
このパラメーターは、Microsoft の内部使用のために予約されています。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-ExchangeArchiveFormat
このパラメーターは、クラウドベースのサービスでのみ機能します。
このパラメーターには、セキュリティ & コンプライアンス PowerShell のエクスポート ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。
ExchangeArchiveFormat パラメーターは、Exchange 検索結果をエクスポートする方法を指定します。 有効な値は次のとおりです。
- PerUserPst: メールボックスごとに 1 つの PST ファイル。
- SinglePst: すべてのエクスポートされたメッセージを含む 1 つの PST ファイル。
- SingleFolderPst:エクスポート全体のための 1 つのルート フォルダーを持つ 1 つの PST ファイル。
- IndividualMessage: 各メッセージを .msg メッセージ ファイルとしてエクスポートします。 これは既定の値です。
- PerUserZip:メールボックスごとに 1 つの ZIP ファイル。 各 ZIP ファイルには、メールボックスからエクスポートされた .msg メッセージ ファイルが含まれています。
- SingleZip: すべてのメールボックスに 1 つの ZIP ファイル。 ZIP ファイルには、すべてのメールボックスからエクスポートされたすべての .msg メッセージ ファイルが含まれています。 この出力設定は PowerShell でのみ使用できます。
SharePoint 検索結果と OneDrive 検索結果の形式を指定するには、SharePointArchiveFormat パラメーターを使用します。
| Type: | ComplianceExportArchiveFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Export
このパラメーターは、クラウドベースのサービスでのみ機能します。
このパラメーターには、セキュリティ & コンプライアンス PowerShell のエクスポート ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。
[エクスポート] スイッチは、コンテンツ検索のアクションとして、検索条件に一致する結果の完全なセットをエクスポートすることを指定します。 このスイッチで値を指定する必要はありません。
レポートで検出された各アイテムに関する情報を返すだけの場合は、Report スイッチを使用します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-FileTypeExclusionsForUnindexedItems
FileTypeExclusionsForUnindexedItems は、インデックスを作成できないため、除外するファイルの種類を指定します。 複数の値をコンマで区切って指定できます。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Force
[強制] スイッチは、警告メッセージまたは確認メッセージを非表示にします。 このスイッチで値を指定する必要はありません。
管理者の入力を求めることが不適切な場合に、このスイッチを使用してタスクをプログラムによって実行することができます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Format
セキュリティ & コンプライアンス PowerShell では、このパラメーターにはエクスポート ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。
Format パラメーターは、Export スイッチを使用するときの、検索結果の形式を指定します。 有効な値は次のとおりです。
- FxStream: PST ファイルにエクスポートします。 これは、Microsoft Purview コンプライアンス ポータルから検索結果をエクスポートするときに使用できる唯一のオプションです。
- Mime: .eml メッセージ ファイルにエクスポートします。 これは、コマンドレットを使用して検索結果をエクスポートするときの既定値です。
- Msg: .msg メッセージ ファイルにエクスポートします。
| Type: | ComplianceDataTransferFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-IncludeCredential
IncludeCredential スイッチは、結果に資格情報を含めるかどうかを指定します。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-IncludeSharePointDocumentVersions
このパラメーターは、クラウドベースのサービスでのみ使用できます。
IncludeSharePointDocumentVersions パラメーターは、Export スイッチを使用する場合に、ドキュメントの以前のバージョンをエクスポートするかどうかを指定します。 有効な値は次のとおりです。
- $true: ドキュメントのすべてのバージョンをエクスポートします。
- $false: トピックの現在の発行済みバージョンのみをエクスポートします。 これは既定の値です。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-JobOptions
このパラメーターは、Microsoft の内部使用のために予約されています。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-NotifyEmail
セキュリティ & コンプライアンス PowerShell では、このパラメーターにはエクスポート ロールが必要です。 既定では、これは電子情報開示マネージャーの役割グループにのみ割り当てられます。
NotifyEmail パラメーターは、Export スイッチを使用する場合に、検索結果の電子メール アドレスの対象を指定します。
指定した受信者は、メッセージの To: フィールドに存在します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-NotifyEmailCC
セキュリティ & コンプライアンス PowerShell では、このパラメーターにはエクスポート ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。
NotifyEmailCC パラメーターは、Export スイッチを使用する場合に、検索結果の電子メール アドレスの対象を指定します。
指定した受信者は、メッセージの Cc: フィールドに存在します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Preview
セキュリティ & コンプライアンス PowerShell では、このパラメーターにはプレビュー ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。
[プレビュー] スイッチは、検索条件に一致する結果をプレビューするコンテンツ検索のアクションを指定します。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Purge
注: セキュリティ & コンプライアンス PowerShell では、このスイッチは検索および消去ロールでのみ使用できます。 既定では、このロールは組織の管理ロール グループとデータ調査担当者ロール グループにのみ割り当てられます。
[消去] スイッチは、検索条件に一致する項目を削除するコンテンツ検索のアクションを指定します。 このスイッチで値を指定する必要はありません。
- メールボックスごとに最大 10 個のアイテムを一度に削除できます。 メッセージを検索し削除するための機能はインシデント対応ツールを意図したものなので、この制限により、メールボックスからすばやくかつ確実にメッセージを削除できます。 このアクションは、ユーザーのメールボックスをクリーンアップするためのものではありません。
- 1 つのコンテンツ検索を使用して、最大 50,000 個のメールボックスからアイテムを削除できます。 50,000 を超えるメールボックスからアイテムを削除するには、個別のコンテンツ検索を作成する必要があります。 詳細については、「 Microsoft 365 組織内のメール メッセージを検索および削除する」を参照してください。
- このスイッチを使用しても、インデックスのないアイテムはメールボックスから削除されません。
- PurgeType パラメーターの値は、項目の削除方法を制御します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-PurgeType
注: セキュリティ & コンプライアンス PowerShell では、このパラメーターは検索および消去ロールでのみ使用できます。 既定では、このロールは組織の管理ロール グループとデータ調査担当者ロール グループにのみ割り当てられます。
PurgeType パラメーターは、アクションが Purge の場合にアイテムを削除する方法を指定します。 有効な値は次のとおりです。
- SoftDelete: 削除されたアイテムは、削除されたアイテムの保持期間の有効期限が切れるまで、ユーザーが回復できます。
- HardDelete (クラウドのみ): 削除されたアイテムはメールボックスから完全に削除されるようにマークされ、次に管理フォルダー アシスタントによってメールボックスが処理されるときに完全に削除されます。 メールボックスで単一アイテムの回復が有効になっている場合、削除されたアイテムの保持期間の有効期限が切れると、削除されたアイテムは完全に削除されます。
| Type: | ComplianceDestroyType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-ReferenceActionName
このパラメーターは、Microsoft の内部使用のために予約されています。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Region
このパラメーターは、Microsoft の内部使用のために予約されています。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Report
このパラメーターは、クラウドベースのサービスでのみ機能します。
[レポート] スイッチは、コンテンツ検索のアクションとして、検索条件に一致する結果 (結果の完全なセットではなく各項目に関する情報) に関するレポートをエクスポートすることを指定します。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-RetentionReport
RetentionReport スイッチは、アイテム保持レポートをエクスポートするコンテンツ検索のアクションを指定します。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-RetryOnError
RetryOnError スイッチは、失敗したアイテムのアクションを、アクション全体にわたってすべて実行し直すことなく、もう一度実行するかどうかを指定します。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Scenario
セキュリティ & コンプライアンス PowerShell では、このパラメーターにはプレビュー ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。
Scenario パラメーターは、Export スイッチを使用するときの、シナリオの種類を指定します。 有効な値は次のとおりです。
- AnalyzeWithZoom: Microsoft Purview eDiscovery Premiumで処理するために検索結果を準備します。
- General: 検索結果をローカル コンピューターにエクスポートします。 電子メールは .pst ファイルにエクスポートされます。 SharePoint ドキュメントと OneDrive for Business ドキュメントは、ネイティブの Office 形式でエクスポートされます。
- GenerateReportsOnly:
- 在庫：
- RetentionReports:
- TriagePreview:
| Type: | ComplianceSearchActionScenario |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Scope
Scope パラメーターは、アクションが Export の場合に、含めるアイテムを指定します。 有効な値は次のとおりです。
- IndexedItemsOnly
- UnindexedItemsOnly
- BothIndexedAndUnindexedItems
| Type: | ComplianceExportScope |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-SearchName
SearchName パラメーターは、コンテンツ検索アクションに関連付ける既存のコンテンツ検索の名前を指定します。 複数のコンテンツ検索をコンマで区切って指定できます。
コンテンツ検索は、コマンド Get-ComplianceSearch |Format-Table -Auto Name,Status.
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-SearchNames
このパラメーターは、クラウドベースのサービスでのみ使用できます。
SearchNames パラメーターは、コンテンツ検索アクションに関連付ける既存のコンテンツ検索の名前を指定します。 コンテンツ検索名はコンマで区切ります。
コンテンツ検索名は、コマンド Get-ComplianceSearch |Format-Table -Auto Name,Status.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-SharePointArchiveFormat
このパラメーターは、クラウドベースのサービスでのみ機能します。
このパラメーターには、エクスポート ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。
SharePointArchiveFormat パラメーターは、SharePoint および OneDrive の検索結果をエクスポートする方法を指定します。 有効な値は次のとおりです。
- IndividualMessage: 圧縮されていないファイルをエクスポートします。 これは既定の値です。
- PerUserZip:ユーザーごとに 1 つの ZIP ファイル。 各 ZIP ファイルには、ユーザーのエクスポートされたファイルが含まれています。
- SingleZip: すべてのユーザーに対して 1 つの ZIP ファイル。 ZIP ファイルには、すべてのユーザーからエクスポートされたすべてのファイルが含まれています。 この出力設定は PowerShell でのみ使用できます。
Exchange 検索結果の形式を指定するには、ExchangeArchiveFormat パラメーターを使用します。
| Type: | ComplianceExportArchiveFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-ShareRootPath
{{ Fill ShareRootPath Description }}
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Version
このパラメーターは、Microsoft の内部使用のために予約されています。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-WhatIf
WhatIf スイッチは、セキュリティ & コンプライアンス PowerShell では機能しません。
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |