New-ComplianceSearchAction

構文

Export

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>]

Preview

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>]

Purge

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>]

説明

例

例 1

New-ComplianceSearchAction -SearchName "Project X" -Preview

例 2

New-ComplianceSearchAction -SearchName "Project X" -Export

例 3

New-ComplianceSearchAction -SearchName "Remove Phishing Message" -Purge -PurgeType SoftDelete

例 4

New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip -ExchangeArchiveFormat PerUserPst -Format FxStream

パラメーター

-ActionName

適用対象: セキュリティ & コンプライアンス

このパラメーターは、クラウドベースのサービスでのみ使用できます。

ActionName パラメーターは、コンテンツ検索アクションの名前を指定します。 このパラメーターは、SearchName パラメーターで複数のコンテンツ検索を指定する場合にのみ使用します。

パラメーターのプロパティ

パラメーター セット

-ArchiveFormat

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

このパラメーターは非推奨となり、使用されなくなりました。

Exchange 検索結果の形式を指定するには、ExchangeArchiveFormat パラメーターを使用します。 SharePoint 検索結果と OneDrive 検索結果の形式を指定するには、SharePointArchiveFormat パラメーターを使用します。

パラメーターのプロパティ

パラメーター セット

-Confirm

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

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

• データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文-Confirm:$falseを使用して、確認プロンプトを省略できます。
• 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。

このコマンドレットには一時停止が組み込まれているため、 -Confirm:$false を使用して確認をスキップします。

パラメーターのプロパティ

パラメーター セット

-EnableDedupe

適用対象: セキュリティ & コンプライアンス

このパラメーターは、クラウドベースのサービスでのみ使用できます。

このパラメーターは、Microsoft の内部使用のために予約されています。

パラメーターのプロパティ

パラメーター セット

-ExchangeArchiveFormat

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。

このパラメーターはクラウドベースのサービスでのみ使用できます。

このパラメーターには、Security & Compliance 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 パラメーターを使用します。

パラメーターのプロパティ

パラメーター セット

-Export

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。

このパラメーターはクラウドベースのサービスでのみ使用できます。

このパラメーターには、Security & Compliance PowerShell のエクスポート ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。

[エクスポート] スイッチは、コンテンツ検索のアクションとして、検索条件に一致する結果の完全なセットをエクスポートすることを指定します。 このスイッチで値を指定する必要はありません。

レポートで検出された各アイテムに関する情報を返すだけの場合は、Report スイッチを使用します。

パラメーターのプロパティ

パラメーター セット

-FileTypeExclusionsForUnindexedItems

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。

FileTypeExclusionsForUnindexedItems は、インデックスを作成できないため、除外するファイルの種類を指定します。 複数の値をコンマで区切って指定できます。

パラメーターのプロパティ

パラメーター セット

-Force

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

[強制] スイッチは、警告メッセージまたは確認メッセージを非表示にします。 このスイッチで値を指定する必要はありません。

管理者の入力を求めることが不適切な場合に、このスイッチを使用してタスクをプログラムによって実行することができます。

パラメーターのプロパティ

パラメーター セット

-Format

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

Security & Compliance PowerShell では、このパラメーターにはエクスポート ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。

Format パラメーターは、Export スイッチを使用するときの、検索結果の形式を指定します。 有効な値は次のとおりです。

• FxStream: PST ファイルにエクスポートします。 これは、Microsoft Purview コンプライアンス ポータルから検索結果をエクスポートするときに使用できる唯一のオプションです。
• Mime: .eml メッセージ ファイルにエクスポートします。 これは、コマンドレットを使用して検索結果をエクスポートするときの既定値です。
• メッセージ: .msg メッセージ ファイルにエクスポートします。

パラメーターのプロパティ

パラメーター セット

-IncludeCredential

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

IncludeCredential スイッチは、結果に資格情報を含めるかどうかを指定します。 このスイッチで値を指定する必要はありません。

パラメーターのプロパティ

パラメーター セット

-IncludeSharePointDocumentVersions

適用対象: セキュリティ & コンプライアンス

注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。

このパラメーターは、クラウドベースのサービスでのみ使用できます。

IncludeSharePointDocumentVersions パラメーターは、Export スイッチを使用する場合に、ドキュメントの以前のバージョンをエクスポートするかどうかを指定します。 有効な値は次のとおりです。

• $true: ドキュメントのすべてのバージョンをエクスポートします。
• $false: ドキュメントの現在の発行済みバージョンのみをエクスポートします。 この値が既定値です。

パラメーターのプロパティ

パラメーター セット

-JobOptions

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

このパラメーターは、Microsoft の内部使用のために予約されています。

パラメーターのプロパティ

パラメーター セット

-NotifyEmail

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。

Security & Compliance PowerShell では、このパラメーターにはエクスポート ロールが必要です。 既定では、これは電子情報開示マネージャーの役割グループにのみ割り当てられます。

NotifyEmail パラメーターは、Export スイッチを使用する場合に、検索結果の電子メール アドレスの対象を指定します。

指定した受信者は、メッセージの To: フィールドに存在します。

パラメーターのプロパティ

パラメーター セット

-NotifyEmailCC

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。

Security & Compliance PowerShell では、このパラメーターにはエクスポート ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。

NotifyEmailCC パラメーターは、Export スイッチを使用する場合に、検索結果の電子メール アドレスの対象を指定します。

指定した受信者は、メッセージの Cc: フィールドに存在します。

パラメーターのプロパティ

パラメーター セット

-Preview

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

Security & Compliance PowerShell では、このパラメーターにはプレビュー ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。

[プレビュー] スイッチは、検索条件に一致する結果をプレビューするコンテンツ検索のアクションを指定します。 このスイッチで値を指定する必要はありません。

パラメーターのプロパティ

パラメーター セット

-Purge

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

注: Security & Compliance PowerShell では、このスイッチは検索および消去ロールでのみ使用できます。 既定では、このロールは組織の管理ロール グループとデータ調査担当者ロール グループにのみ割り当てられます。

[消去] スイッチは、検索条件に一致する項目を削除するコンテンツ検索のアクションを指定します。 このスイッチで値を指定する必要はありません。

• メールボックスごとに最大 10 個のアイテムを一度に削除できます。 メッセージを検索し削除するための機能はインシデント対応ツールを意図したものなので、この制限により、メールボックスからすばやくかつ確実にメッセージを削除できます。 このアクションは、ユーザーのメールボックスをクリーンアップするためのものではありません。

  ヒント: 10 個を超えるアイテムを消去するには、Microsoft Graph APIの「電子情報開示検索: purgeData」を参照してください。これにより、1 か所あたり最大 100 個のアイテムを削除できます。

• 1 つのコンテンツ検索を使用して、最大 50,000 個のメールボックスからアイテムを削除できます。 50,000 を超えるメールボックスからアイテムを削除するには、個別のコンテンツ検索を作成する必要があります。 詳細については、「Microsoft 365 organizationで電子メール メッセージを検索および削除する」を参照してください。

• このスイッチを使用しても、インデックスのないアイテムはメールボックスから削除されません。

• PurgeType パラメーターの値は、項目の削除方法を制御します。

パラメーターのプロパティ

パラメーター セット

-PurgeType

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

注: Security & Compliance PowerShell では、このパラメーターは検索ロールと消去ロールでのみ使用できます。 既定では、このロールは組織の管理ロール グループとデータ調査担当者ロール グループにのみ割り当てられます。

PurgeType パラメーターは、アクションが Purge の場合にアイテムを削除する方法を指定します。 有効な値は次のとおりです。

• SoftDelete: 削除されたアイテムは、削除されたアイテムの保持期間の有効期限が切れるまで、ユーザーが回復できます。
• HardDelete (クラウドのみ): 削除されたアイテムはメールボックスから完全に削除されるようにマークされ、次に管理フォルダー アシスタントによってメールボックスが処理されるときに完全に削除されます。 メールボックスで単一アイテムの回復が有効になっている場合、削除されたアイテムの保持期間の有効期限が切れた後、削除されたアイテムは完全に削除されます。

パラメーターのプロパティ

パラメーター セット

-ReferenceActionName

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

このパラメーターは、Microsoft の内部使用のために予約されています。

パラメーターのプロパティ

パラメーター セット

-Region

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

このパラメーターは、Microsoft の内部使用のために予約されています。

パラメーターのプロパティ

パラメーター セット

-Report

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。

このパラメーターはクラウドベースのサービスでのみ使用できます。

[レポート] スイッチは、コンテンツ検索のアクションとして、検索条件に一致する結果 (結果の完全なセットではなく各項目に関する情報) に関するレポートをエクスポートすることを指定します。 このスイッチで値を指定する必要はありません。

パラメーターのプロパティ

パラメーター セット

-RetentionReport

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。

RetentionReport スイッチは、アイテム保持レポートをエクスポートするコンテンツ検索のアクションを指定します。 このスイッチで値を指定する必要はありません。

パラメーターのプロパティ

パラメーター セット

-RetryOnError

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

RetryOnError スイッチは、失敗したアイテムのアクションを、アクション全体にわたってすべて実行し直すことなく、もう一度実行するかどうかを指定します。 このスイッチで値を指定する必要はありません。

パラメーターのプロパティ

パラメーター セット

-Scenario

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

Security & Compliance PowerShell では、このパラメーターにはプレビュー ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。

Scenario パラメーターは、シナリオの種類を指定します。 有効な値は次のとおりです。

• AnalyzeWithZoom: Microsoft Purview eDiscovery Premiumで処理するために検索結果を準備します。
• General: 検索結果をローカル コンピューターにエクスポートします。 電子メールは .pst ファイルにエクスポートされます。 SharePoint ドキュメントと OneDrive ドキュメントは、ネイティブの Office 形式でエクスポートされます。
• GenerateReportsOnly
• インベントリ
• RetentionReports
• TriagePreview

パラメーターのプロパティ

パラメーター セット

-Scope

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。

Scope パラメーターは、アクションが Export の場合に、含めるアイテムを指定します。 有効な値は次のとおりです。

• IndexedItemsOnly
• UnindexedItemsOnly
• BothIndexedAndUnindexedItems

パラメーターのプロパティ

パラメーター セット

-SearchName

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

SearchName パラメーターは、コンテンツ検索アクションに関連付ける既存のコンテンツ検索の名前を指定します。 複数のコンテンツ検索をコンマで区切って指定できます。

コンテンツ検索は、コマンド Get-ComplianceSearch |Format-Table -Auto Name,Status.

パラメーターのプロパティ

パラメーター セット

-SearchNames

適用対象: セキュリティ & コンプライアンス

このパラメーターは、クラウドベースのサービスでのみ使用できます。

SearchNames パラメーターは、コンテンツ検索アクションに関連付ける既存のコンテンツ検索の名前を指定します。 コンテンツ検索名はコンマで区切ります。

コンテンツ検索名は、コマンド Get-ComplianceSearch |Format-Table -Auto Name,Status.

パラメーターのプロパティ

パラメーター セット

-SharePointArchiveFormat

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。

このパラメーターはクラウドベースのサービスでのみ使用できます。

このパラメーターには、エクスポート ロールが必要です。 既定では、このロールは電子情報開示マネージャーの役割グループにのみ割り当てられます。

SharePointArchiveFormat パラメーターは、SharePoint および OneDrive の検索結果をエクスポートする方法を指定します。 有効な値は次のとおりです。

• IndividualMessage: 圧縮されていないファイルをエクスポートします。 この値が既定値です。
• PerUserZip:ユーザーごとに 1 つの ZIP ファイル。 各 ZIP ファイルには、ユーザーのエクスポートされたファイルが含まれています。
• SingleZip: すべてのユーザーに対して 1 つの ZIP ファイル。 ZIP ファイルには、すべてのユーザーからエクスポートされたすべてのファイルが含まれています。 この出力設定は、PowerShell でのみ使用できます。

Exchange 検索結果の形式を指定するには、ExchangeArchiveFormat パラメーターを使用します。

パラメーターのプロパティ

パラメーター セット

-ShareRootPath

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE

このパラメーターは、オンプレミスの Exchange でのみ使用できます。

注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。

{{ Fill ShareRootPath Description }}

パラメーターのプロパティ

パラメーター セット

-Version

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

このパラメーターは、Microsoft の内部使用のために予約されています。

パラメーターのプロパティ

パラメーター セット

-WhatIf

適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス

WhatIf スイッチは、セキュリティ/コンプライアンス PowerShell では機能しません。

WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。

パラメーターのプロパティ

パラメーター セット

CommonParameters