Get-ComplianceSearchAction
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターと設定は、1 つの環境または他の環境に限定される場合があります。
Get-ComplianceSearchAction コマンドレットを使用して、コンプライアンス検索アクションに関する情報を表示します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Identity
Get-ComplianceSearchAction
[[-Identity] <ComplianceSearchActionIdParameter>]
[-Case <String>]
[-Details]
[-DomainController <Fqdn>]
[-IncludeCredential]
[-Organization <OrganizationIdParameter>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
Preview
Get-ComplianceSearchAction
[-Preview]
[-Case <String>]
[-Details]
[-DomainController <Fqdn>]
[-IncludeCredential]
[-Organization <OrganizationIdParameter>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
Purge
Get-ComplianceSearchAction
[-Purge]
[-Case <String>]
[-Details]
[-DomainController <Fqdn>]
[-IncludeCredential]
[-Organization <OrganizationIdParameter>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
Export
Get-ComplianceSearchAction
[-Export]
[-Case <String>]
[-Details]
[-DomainController <Fqdn>]
[-IncludeCredential]
[-Organization <OrganizationIdParameter>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
説明
New-ComplianceSearch コマンドレットを使用してコンプライアンス検索を作成して実行し、Start-ComplianceSearch コマンドレットを使用して検索を開始したら、New-ComplianceSearchAction コマンドレットを使用して検索アクションを割り当てます。 Get-ComplianceSearchAction コマンドレットを使用して、コンプライアンス検索アクションの進行状況を追跡します。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
オンプレミスの Exchange では、このコマンドレットはメールボックス検索ロールで使用できます。 既定では、このロールは Discovery Management ロール グループにのみ割り当てられます。
セキュリティ/コンプライアンス PowerShell でこのコマンドレットを使用するには、アクセス許可が割り当てられている必要があります。 詳細については、「Microsoft Purview コンプライアンス センターのアクセス許可」 を参照してください。
例
例 1
Get-ComplianceSearchAction
この例では、すべてのコンプライアンス検索アクションの概要リストを示します。
例 2
Get-ComplianceSearchAction -Identity "Case 1234_Preview" | Format-List
この例では、"Case 1234_Preview" という名前のコンプライアンス検索アクションの詳細を示します
パラメーター
-Case
適用対象: セキュリティ & コンプライアンス
このパラメーターは、クラウドベースのサービスでのみ使用できます。
Case パラメーターは、指定したケースの名前で結果をフィルター処理します。 値にスペースが含まれている場合は、値を引用符で囲んでください。
パラメーターのプロパティ
型: | String |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Details
適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス
[詳細] スイッチは、結果に詳細情報を含めるかどうかを指定します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
型: | SwitchParameter |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-DomainController
適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス
このパラメーターは、オンプレミスの Exchange でのみ使用可能で正常に機能します。
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
パラメーターのプロパティ
型: | Fqdn |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Export
適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス
注: 2025 年 5 月 26 日以降、このパラメーターは機能しなくなります。 詳細については、「Microsoft Purview eDiscoveryに対する今後の変更」を参照してください。
[エクスポート] スイッチは、コンプライアンス検索アクションのエクスポートによって結果をフィルター処理します。 このスイッチで値を指定する必要はありません。
ID、プレビュー、または消去パラメーターでは、このスイッチを使用できません。
パラメーターのプロパティ
型: | SwitchParameter |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
Export
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス
Identity パラメーターは、表示するコンプライアンス検索アクションを指定します。 コンプライアンス検索アクションを一意に識別する任意の値を使用できます。 例:
- 名前: コンプライアンス検索アクション名は構文
"Compliance Search Name_Action"
を使用します。 たとえば、「"Case 1234_Preview"
」のように入力します。 - JobRunId (GUID)
このパラメーターは、エクスポート、プレビュー、または消去パラメーターでは使用できません。
Identity パラメーターを使用すると、結果に詳細が返されます。 例:
- [結果] 行には、Item count、Total size、Details プロパティの値が設定されます。
- 場所の行が結果に追加されます。
- NumBindings プロパティの値が設定されます。 このプロパティには、プライマリ メールボックス、メイン アーカイブ、および検索に含まれるユーザー用の追加アーカイブが含まれます。 NumBindings は検索に含まれるユーザーの数ではありません。含まれる各ユーザーは、プライマリ メールボックス、メイン アーカイブ、および追加のアーカイブの組み合わせを持っている場合と組み合わせられない可能性があるためです。
- 影響を受ける場所のプロパティ (ExchangeLocation など) が設定されます。
- CaseName プロパティの値が設定されます。
パラメーターのプロパティ
型: | ComplianceSearchActionIdParameter |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
Identity
配置: | 1 |
必須: | False |
パイプラインからの値: | True |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-IncludeCredential
適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス
IncludeCredential スイッチは、結果に資格情報を含めるかどうかを指定します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
型: | SwitchParameter |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Organization
適用対象: セキュリティ & コンプライアンス
このパラメーターは、クラウドベースのサービスでのみ使用できます。
このパラメーターは、Microsoft の内部使用のために予約されています。
パラメーターのプロパティ
型: | OrganizationIdParameter |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Preview
適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス
プレビュー スイッチは、プレビュー コンプライアンス検索アクションによって結果をフィルター処理します。 このスイッチで値を指定する必要はありません。
このスイッチは、エクスポート、ID、または消去の各パラメーターでは使用できません。
パラメーターのプロパティ
型: | SwitchParameter |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
Preview
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Purge
適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス
注: Security & Compliance PowerShell では、このパラメーターは検索ロールと消去ロールでのみ使用できます。 既定では、このロールは組織の管理ロール グループとデータ調査担当者ロール グループにのみ割り当てられます。
[消去] スイッチは、コンプライアンス検索アクションの消去によって結果をフィルター処理します。 このスイッチで値を指定する必要はありません。
エクスポート、ID、またはプレビュー パラメーターでは、このスイッチを使用できません。
パラメーターのプロパティ
型: | SwitchParameter |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
Purge
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-ResultSize
適用対象: Exchange Server 2016、Exchange Server 2019、Exchange Server SE、セキュリティ & コンプライアンス
ResultSize パラメーターは、返される結果の最大数を指定します。 クエリに一致するすべてのリクエストを返す場合は、このパラメーターの値に unlimited を使用します。 既定値は 1,000 です。
パラメーターのプロパティ
型: | Unlimited |
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。