Get-MailboxSearch

リファレンス

モジュール:: ExchangePowerShell

適用対象:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

このコマンドレットは、オンプレミスの Exchange およびクラウドベースのサービスで使用できます。一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。

Get-MailboxSearch コマンドレットを使用して、進行中、完了、または停止中のメールボックス検索を表示します。

注: 2020 年 10 月の時点で、*-MailboxSearch コマンドレットは powerShell Exchange Online廃止されます。代わりに、セキュリティ & コンプライアンス PowerShell で *-ComplianceSearch コマンドレットを使用します。詳細については、「従来の電子情報開示ツールの廃止」を参照してください。

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

構文

Get-MailboxSearch
   [[-Identity] <SearchObjectIdParameter>]
   [-DomainController <Fqdn>]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

Get-MailboxSearch
   [[-Identity] <EwsStoreObjectIdParameter>]
   [-ShowDeletionInProgressSearches]
   [-DomainController <Fqdn>]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

Get-MailboxSearch
   -InPlaceHoldIdentity <String>
   [-ShowDeletionInProgressSearches]
   [-DomainController <Fqdn>]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

説明

オンプレミスの Exchange では、メールボックス検索を使用して、In-Place電子情報開示を実行したり、ユーザーをIn-Place保留にしたりします。どちらの種類のメールボックス検索でも、詳細を取得するには、Get-MailboxSearch コマンドレットを使用します。

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。

例

例 1

Get-MailboxSearch -ResultSize "unlimited"

この例では、すべてのメールボックスの検索一覧を取得します。

例 2

Get-MailboxSearch "Project Hamilton" | Format-List

この例では、メールボックス検索 Project Hamilton のすべてのプロパティを取得します。

Identity パラメーターは位置パラメーターです。位置パラメーターはラベル (Identity) なしで使用できます。位置指定パラメーターの詳細については、「パラメーターについて」を参照してください。

例 3

(Get-Mailbox Mark).InPlaceHolds

Get-MailboxSearch -InPlaceHoldIdentity 9953d0f0fd03415e949d4b41c5a28cbb

この例では、ユーザーが配置されているインプレース保持を取得します。最初のコマンドは、In-Place Holds の GUID を出力します。最後のコマンドは、ユーザーが配置されているIn-Place保留の GUID に基づいてメールボックス検索を取得します。

パラメーター

-DomainController

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

DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメインコントローラーを指定します。ドメインコントローラーは、完全修飾ドメイン名 (FQDN) で識別します。たとえば、dc01.contoso.com です。

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Identity

Identity パラメーターには、検索クエリの名前を指定します。名前を指定しない場合は、すべてのメールボックス検索クエリが返されます。

Exchange Onlineでこのコマンドレットのパフォーマンスを向上させるために、メールボックス検索の名前を指定しないと、一部のメールボックス検索プロパティが返されません。以下のプロパティがあります。

SourceMailboxes
ソース
SearchQuery
ResultsLink
PreviewResultsLink
エラー

これらのプロパティを表示するには、メールボックス検索の名前を指定する必要があります。

Type:	SearchObjectIdParameter
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-InPlaceHoldIdentity

InPlaceHoldIdentity パラメーターは、インプレース保持の GUID を指定します。このパラメーターを使用して、ユーザーを配置するインプレース保持を検索できます。ユーザーが配置されているすべてのインプレース保持の GUID が、ユーザーの InPlaceHolds プロパティに追加されます。プロパティは、Get-Mailbox コマンドレットを使用して取得できます。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-ResultSize

ResultSize パラメーターは、返される結果の最大数を指定します。クエリに一致するすべてのリクエストを返す場合は、このパラメーターの値に unlimited を使用します。既定値は 1,000 です。

Type:	Unlimited
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-ShowDeletionInProgressSearches

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

入力

Input types

このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。

出力

Output types

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。