Set-MailboxSearch

リファレンス

モジュール:: ExchangePowerShell

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

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

既存のメールボックス検索を変更するには、Set-MailboxSearch コマンドレットを使用します。

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

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

構文

Set-MailboxSearch
   [-Identity] <SearchObjectIdParameter>
   [-AllPublicFolderSources <Boolean>]
   [-AllSourceMailboxes <Boolean>]
   [-Confirm]
   [-Description <String>]
   [-DomainController <Fqdn>]
   [-DoNotIncludeArchive]
   [-EndDate <ExDateTime>]
   [-EstimateOnly]
   [-ExcludeDuplicateMessages <Boolean>]
   [-Force]
   [-IncludeKeywordStatistics]
   [-IncludeUnsearchableItems <Boolean>]
   [-InPlaceHoldEnabled <Boolean>]
   [-ItemHoldPeriod <Unlimited>]
   [-Language <CultureInfo>]
   [-LogLevel <LoggingLevel>]
   [-MessageTypes <KindKeyword[]>]
   [-Name <String>]
   [-Recipients <String[]>]
   [-SearchDumpster <Boolean>]
   [-SearchQuery <String>]
   [-Senders <String[]>]
   [-SourceMailboxes <RecipientIdParameter[]>]
   [-StartDate <ExDateTime>]
   [-StatisticsStartIndex <Int32>]
   [-StatusMailRecipients <RecipientIdParameter[]>]
   [-TargetMailbox <MailboxIdParameter>]
   [-WhatIf]
   [<CommonParameters>]

説明

オンプレミスの Exchange では、メールボックス検索は電子情報開示とIn-Place保留In-Placeに使用されます。インプレース電子情報開示の場合は、検索先メールボックスを指定しておかないと、組織内のすべてのメールボックスサーバー上のメールボックスが検索されます。インプレース保持を作成するには、SourceMailboxes パラメーターを使用して、保持するメールボックスを指定する必要があります。検索は停止、開始、変更、および削除が可能です。

既定では、SourceMailboxes パラメーターを使用して検索を制限しない限り、組織内のすべての Exchange 2013 以降のメールボックスサーバーでメールボックス検索が実行されます。 Exchange 2010 メールボックスサーバー上のメールボックスを検索するには、Exchange 2010 サーバーでコマンドを実行します。

変更対象のインプレース電子情報開示検索が実行中のときは、その検索を停止してから Set-MailboxSearch コマンドレットを使用してください。検索を再開すると、以前の検索結果がすべて、検索先メールボックスから削除されます。

詳細については、「Exchange Serverのインプレース電子情報開示」と「Exchange Server でのインプレースホールドと訴訟ホールド」を参照してください。

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

例

例 1

Set-MailboxSearch -Identity "Legal-ProjectX" -StartDate "01/01/2017"

この例では、メールボックス検索の開始日を変更します。

例 2

Set-MailboxSearch -Identity "Legal-ProjectX" -AllPublicFolderSources $true

オンプレミスの Exchange では、この例では、Legal-ProjectX という名前の既存のメールボックス検索にすべてのパブリックフォルダーを追加します。

注: この検索の結果を保留In-Place配置する場合は、AllSourceMailboxes パラメーターを $false に設定する必要があります。 SourceMailboxes パラメーターを使用して、検索に特定のメールボックスを含め続けることができました。

パラメーター

-AllPublicFolderSources

AllPublicFolderSources パラメーターは組織内のすべてのパブリックフォルダーを検索に含めるかどうかを指定します。有効な値は次のとおりです。

$true: すべてのパブリックフォルダーが検索に含まれます。この値は、SourceMailboxes パラメーターを使用して 1 つ以上のソースメールボックスを指定しない$falseand AllSourceMailboxes パラメーターの値が必要です (パラメーター値は空白 [$null])。
$false: 検索にパブリックフォルダーは含まれません。これは既定の値です。この値は、SourceMailboxes パラメーターを使用して 1 つ以上のソースメールボックスを指定$trueor、AllSourceMailboxes パラメーターの値がである場合に使用できます (パラメーター値は空白 [$null] ではありません)。

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

-AllSourceMailboxes

AllSourceMailboxes パラメーターは、検索にすべてのメールボックスを含めるかどうかを指定します。有効な値は次のとおりです。

$true: すべてのメールボックスが検索に含まれます。この値は、AllPublicFolderSources パラメーターの値が SourceMailboxes パラメーターを使用して 1 つ以上のソースメールボックスを指定しない$falseand場合に必要です (パラメーター値は空白 [$null])。
$false: すべてのメールボックスが検索に含まれていません。これは既定の値です。この値は、AllPublicFolderSources パラメーターの値が SourceMailboxes パラメーターを使用して 1 つ以上のソースメールボックスを指定$trueor場合に使用できます (パラメーター値は空白 [$null] ではありません)。

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

-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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-Description

Description パラメーターは、検索の説明を指定します。値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。

Type:	String
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

-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

-DoNotIncludeArchive

このパラメーターは Exchange Server 2010 でのみ使用できます。

DoNotIncludeArchive スイッチは、ユーザーのアーカイブメールボックス内のアイテムをメールボックス検索から除外します。このスイッチで値を指定する必要はありません。

既定では、ユーザーのアーカイブメールボックス内のアイテムはメールボックス検索に含まれます。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010

-EndDate

EndDate パラメーターには、日付範囲の終了日を指定します。

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

終了日をクリアするには、$null値を使用します。

Type:	ExDateTime
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

-EstimateOnly

EstimateOnly スイッチは、ターゲットメールボックスにメッセージをコピーせずに返されるアイテムの数の見積もりのみを提供します。このスイッチで値を指定する必要はありません。

Type:	SwitchParameter
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

-ExcludeDuplicateMessages

ExcludeDuplicateMessages パラメーターは、インプレース電子情報開示検索におけるメールボックス全体のメッセージの重複をなくします。有効な値は次のとおりです。

$true: 同じメッセージが複数のフォルダーまたはメールボックスに存在する場合は、メッセージの 1 つのインスタンスをコピーします。これは既定の値です。
$false: 同じメッセージが複数のフォルダーまたはメールボックスに存在する場合は、メッセージのすべてのインスタンスをコピーします。

Type:	Boolean
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

-Force

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

これを切り替えると、以前の検索結果がターゲットメールボックスから削除され、検索が再開されることを示す確認プロンプトが非表示になります。

Type:	SwitchParameter
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

-Identity

Identity パラメーターは、変更するメールボックス検索の名前を指定します。値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。

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

-IncludeKeywordStatistics

IncludeKeywordStatistics スイッチは、キーワード統計 (各キーワードのインスタンス数) を返します。このスイッチで値を指定する必要はありません。

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

-IncludeUnsearchableItems

IncludeUnsearchableItems パラメーターは、Exchange Search でインデックスを作成できなかったアイテムを結果に含めるかどうかを指定します。有効な値は次のとおりです。

$true: 検索できない項目が結果に含まれます。
$false: 検索できない項目は結果に含まれません。これは既定の値です。

検索不能アイテムはクエリベースのインプレース保持用に保持されません。検索不能アイテムを保持する必要がある場合は、不確定保持 (検索パラメーターを指定しない保持で、訴訟ホールドに似た機能を提供するもの) を作成する必要があります。

Type:	Boolean
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

-InPlaceHoldEnabled

InPlaceHoldEnabled パラメーターは、検索結果のアイテムをインプレース保持にするどうかを指定します。有効な値は次のとおりです。

$true: 検索結果In-Place保留が有効になっています。
$false: 検索結果In-Place保留が有効になっていません。これは既定の値です。

AllSourceMailboxes パラメーターが $true のときは、検索結果をインプレース保持にすることはできません。

保留を試行しても SourceMailboxes パラメーターを使用してメールボックスを指定しない場合、コマンドは成功する可能性がありますが、メールボックスは保留In-Placeに配置されません。

Type:	Boolean
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, Exchange Online Protection

-ItemHoldPeriod

ItemHoldPeriod パラメーターは、メールボックスアイテム (すべてのアイテムまたは検索クエリ結果で返されるメールボックスアイテム) のIn-Placeホールドの日数を指定します。このパラメーターを InPlaceHoldEnabled パラメーターと共に使用して、In-Place Hold を設定します。期間は、メールボックスでアイテムを受信したとき、またはアイテムが作成されたときから計算します。有効な値は次のとおりです。

SyncSchedule パラメーターは、??? を指定します。このパラメーターの有効な値は次のとおりです。
値は unlimited です。これは既定の値です。アイテムは、In-Place Remove-MailboxSearch コマンドレットを使用して検索を削除し、Set-MailboxSearch コマンドレットと SourceMailboxes パラメーターを使用して検索からソースメールボックスを削除するか、オンプレミスの Exchange で、Set-MailboxSearch コマンドレットを使用してすべてのパブリックフォルダーを削除して、AllPublicFolderSources パラメーターを$trueから$falseに変更するまで保持されます。

Type:	Unlimited
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, Exchange Online Protection

-Language

Language パラメーターは、メールボックス検索のロケールを指定します。

このパラメーターの正しい入力は、Microsoft .NET Framework CultureInfo クラスでサポートされているカルチャコード値です。たとえば、デンマーク語の場合には da-DK、日本語の場合には ja-JP となります。詳細については、「CultureInfo クラス」を参照してください。

Type:	CultureInfo
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

-LogLevel

LogLevel パラメーターは、メールボックス検索のログ出力レベルを指定します。有効な値は次のとおりです。

基本: 検索の基本的な詳細は保持されます。これは既定の値です。
Full: Basic ログレベルの詳細に加えて、返されるすべてのメッセージの完全な一覧が含まれます。
抑制: ログ記録は抑制されます。ログは保持されません。

Type:	LoggingLevel
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

-MessageTypes

MessageTypesパラメーターには、検索クエリに含めるメッセージの種類を指定します。有効な値は次のとおりです。

連絡先
Docs
メール
IM
仕訳帳
会議
注意事項
タスク

複数の値をコンマで区切って指定できます。

既定値は空白 ($null) です。これは、すべてのメッセージの種類が含まれるという意味です。指定したすべての値をクリアするには、$null値を使用します。

Type:	KindKeyword[]
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

-Name

Name パラメーターは、検索の名前を指定します。値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。

このパラメーターの値を使って、TargetMailbox パラメーターで指定されている対象のメールボックスに検索結果を保持するトップレベルフォルダーを作成します。

Type:	String
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

-Recipients

Recipients パラメーターは、検索クエリに含める 1 つ以上の受信者を指定します。 [宛先]、[CC]、[BCC] フィールド内に指定の受信者があるメッセージが検索結果に返されます。

複数の受信者をコンマで区切って指定できます。値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。

受信者をクリアするには、$null値を使用します。

Type:	String[]
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

-SearchDumpster

このパラメーターは Exchange Server 2010 でのみ使用できます。

SearchDumpster パラメーターは、ダンプスターを検索するかどうかを指定します。ごみ箱は、削除済みアイテムフォルダーから削除または削除された後、またはハード削除された後、および削除されたアイテムの保持設定に基づいてメールボックスから削除される前に、削除されたアイテムが一時的に格納されるメールボックス内のストレージ領域です。

値を $true に設定してダンプスターの検索を有効にするか、$falseに設定して無効にします。

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010

-SearchQuery

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

このパラメーターを他の検索クエリパラメーターと一緒に使う場合、クエリは AND 演算子でこれらのパラメーターを結合します。

その他の検索クエリのパラメーターは次のとおりです。

EndDate
MessageTypes
受信者
送信者
StartDate

Type:	String
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

-Senders

Senders パラメーターは、検索クエリに含める 1 人または複数の送信者を指定します。指定した送信者のメッセージは、検索結果に返されます。送信者としては、たとえば、ユーザー、配布グループ (グループのメンバーにより送信されたメッセージ)、SMTP アドレス、ドメインなどを指定できます。

複数の送信者をコンマで区切って指定できます。値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。

送信者をクリアするには、$null値を使用します。

Type:	String[]
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

-SourceMailboxes

SourceMailboxes パラメーターは検索するメールボックスを指定します。メールボックスを一意に識別する任意の値を使用できます。次に例を示します。

名前
Alias
識別名 (DN)
正規 DN
電子メールアドレス
GUID

Update 値にスペースが含まれている場合、または引用符が必要な場合は、次の構文を使用します。 "Value1","Value2",..."ValueN"

このパラメーターを使用するには、AllSourceMailboxes パラメーターを$falseする必要があります (既定値)。

ソースメールボックスをクリアするには、$null値を使用します。

検索結果を保留In-Place有効にするには、AllSourceMailboxes パラメーターを $false (既定値) に設定し、次の設定のいずれかまたは両方を構成する必要があります。

SourceMailboxes パラメーターを使用して、1 つ以上のソースメールボックスを指定します。
オンプレミス Exchange で、AllPublicFolderSources パラメーターを $true に設定します。

Type:	RecipientIdParameter[]
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

-StartDate

StartDate パラメーターは、日付範囲の開始日を指定します。

開始日をクリアするには、$null値を使用します。

Type:	ExDateTime
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

-StatisticsStartIndex

StatisticsStartIndex パラメーターは、Exchange 管理センター (EAC) によって、ページ操作でキーワード統計を取得するために使用されます。

Type:	Int32
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

-StatusMailRecipients

StatusMailRecipients パラメーターは、検索の完了時に電子メールで状態メッセージを受信する 1 人または複数の受信者を指定します。受信者を一意に識別する任意の値を使用できます。たとえば、次の値を使用できます。

名前
Alias
識別名 (DN)
正規 DN
電子メールアドレス
GUID