Set-MailboxSearch
內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 有些參數和設定可能是某一個環境所專屬。
使用 Set-MailboxSearch 指令程式來修改現有的信箱搜尋。
注意:自 2020 年 10 月起,*-MailboxSearch Cmdlet 已在 Exchange Online PowerShell 中淘汰。 請改用安全 & 性合規性 PowerShell 中的 *-ComplianceSearch Cmdlet。 如需詳細資訊,請參閱 淘汰舊版電子檔探索工具。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
Syntax
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>]
Description
在內部部署 Exchange 中,信箱搜尋會用於In-Place電子檔探索和In-Place保留。 針對 In-Place eDiscovery,除非特別指定,否則會搜尋組織中所有 Mailbox Server 上的信箱。 若要建立 In-Place Hold,您必須使用 SourceMailboxes 參數指定要保留的信箱。 您可以停止、啟動、修改及移除搜尋。
根據預設,信箱搜尋會在組織中的所有 Exchange 2013 或更新版本信箱伺服器上執行,除非您使用 SourceMailboxes 參數將搜尋限制為較少的信箱。 若要在 Exchange 2010 信箱伺服器上搜尋信箱,請在 Exchange 2010 伺服器上執行 命令。
如果您想要修改的 In-Place eDiscovery 搜尋正在執行,請在使用 Set-MailboxSearch 指令程式之前,先將其停止。 重新開始搜尋時,會從目標信箱移除先前任何的搜尋結果。
如需詳細資訊,請參閱Exchange Server 中的就地電子檔探索和Exchange Server中的就地保留和訴訟保留。
您必須已獲指派權限,才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數,不過,如果某些參數並未包含在指派給您的權限中,您可能就無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 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 Hold 上,則 AllSourceMailboxes 參數必須設定為 $false。 我們仍然可以使用 SourceMailboxes 參數,在搜尋中包含特定信箱。
參數
-AllPublicFolderSources
AllPublicFolderSources 參數會指定是否要將搜尋中的所有組織公用資料夾包含在內。 有效值為:
- $true:搜尋中包含所有公用資料夾。 當 AllSourceMailboxes 參數的值$falseand您未使用 SourceMailboxes 參數指定一或多個來源信箱, (參數值為空白 [$null]) 時,就需要此值。
- $false:搜尋中不包含公用資料夾。 這是預設值。 當 AllSourceMailboxes 參數的值$trueor您使用 SourceMailboxes 參數指定一或多個來源信箱, (參數值不是空白 [$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 參數的值$falseand您未使用 SourceMailboxes 參數指定一或多個來源信箱, (參數值為空白 [$null]) 時,就需要此值。
- $false:所有信箱都不包含在搜尋中。 這是預設值。 當 AllPublicFolderSources 參數的值$trueor您使用 SourceMailboxes 參數指定一或多個來源信箱, (參數值不是空白 [$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 參數會指定要顯示或隱藏確認提示。 這個參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續作業。
- 例如,具破壞性的 Cmdlet (例如 Remove-* Cmdlet) 內建暫停,可強制您在繼續之前確認命令。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:
-Confirm:$false
。 - 其他大部分的 Cmdlet (例如,New-* 和 Set-* Cmdlet) 沒有內建暫停。 在使用這些 Cmdlet 時,指定不含任何值的 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 參數會指定此 Cmdlet 用來向 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
此參數僅適用于 2010 Exchange Server。
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 參數會在 In-Place eDiscovery 搜尋中跨信箱消除重複的郵件。 有效值為:
- $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 |
-Force
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 搜尋編制索引的專案。 有效值為:
- $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保留。 持續時間自接收或建立信箱項目的時間開始計算。 有效值為:
- SyncSchedule 參數會指定 ???。此參數的有效值為:
- 值 unlimited。 這是預設值。 專案會保留到移除In-Place保留,方法是使用 Remove-MailboxSearch Cmdlet 移除搜尋、使用 Set-MailboxSearch Cmdlet 和 SourceMailboxes 參數從搜尋中移除來源信箱,或在內部部署 Exchange 中,使用 Set-MailboxSearch Cmdlet 將 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 參數會指定信箱搜尋的記錄層級。 有效值為:
- 基本:保留搜尋的基本詳細資料。 這是預設值。
- 完整:除了基本記錄層級中的詳細資料之外,還會包含所有傳回訊息的完整清單。
- 隱藏:隱藏記錄。 不會保留任何記錄。
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
- 電子郵件
- 我
- 期刊
- 會議
- 注意事項
- 工作
您可以指定多個以逗號分隔的值。
預設值為空白 ($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 參數會指定搜尋查詢中包含的一或多個收件者。 會在搜尋結果中傳回 [收件者]、[複本] 及 [密件複本] 欄位中有指定收件者的郵件。
您可以指定多個收件者 (以逗號隔開)。 如果值包含空格,請使用引號 (") 括住值。
若要清除收件者,請使用值$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
此參數僅適用于 2010 Exchange Server。
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) 語法參考 和 eDiscovery 的關鍵字查詢和搜尋條件。
如果您同時使用其他搜尋查詢參數和此參數,則查詢會使用 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 參數會指定一或多個要在搜尋查詢中包含的寄件者。 會在搜尋結果中傳回具有指定寄件者的郵件。 寄件者可包含使用者、通訊群組 (群組成員寄送的郵件)、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 參數會指定要搜尋的信箱。 您可以使用可唯一識別信箱的任何值。 例如:
- 名稱
- 別名
- 辨別名稱 (DN)
- 辨別名稱 (DN)
- 標準 DN
- GUID
您可以輸入多個以逗號分隔的值。 如果值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
若要使用此參數,AllSourceMailboxes 參數必須$false (預設值) 。
若要清除來源信箱,則使用值 $null。
若要啟用In-Place保留搜尋結果,您必須將 AllSourceMailboxes 參數設定為$false (預設值) ,並設定下列其中一個或兩個設定:
- 使用 SourceMailboxes 參數指定一或多個來源信箱。
- 在內部部署 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 參數會指定日期範圍的開始日期。
在您要執行命令的電腦上,使用該電腦的 [地區選項] 設定中定義的簡短日期格式。 例如,如果電腦設定成使用簡短日期格式 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 |
-StatisticsStartIndex
Exchange 系統管理中心 (EAC) 會使用 StatisticsStartIndex 參數來擷取分頁作業中的關鍵字統計資料。
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 參數會指定一或多個收件者,以在搜尋完成時接收狀態電子郵件。 您可以使用唯一識別收件者的任何值。 例如:
- 名稱
- 別名
- 辨別名稱 (DN)
- 辨別名稱 (DN)
- 標準 DN
- GUID
您可以輸入多個以逗號分隔的值。 如果值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"
。
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 |
-TargetMailbox
TargetMailbox 參數會指定搜尋結果副本所在的目的地信箱。 您可以使用可唯一識別信箱的任何值。 例如:
- 名稱
- 別名
- 辨別名稱 (DN)
- 辨別名稱 (DN)
- Domain\Username
- 電子郵件地址
- GUID
- LegacyExchangeDN
- SamAccountName
- 使用者識別碼或使用者主要名稱 (UPN)
Type: | MailboxIdParameter |
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 |
-WhatIf
WhatIf 參數會模擬命令的動作。 使用此參數時,您不需要實際套用變更即可檢視可能會發生的變更。 您不需要使用此參數指定值。
Type: | SwitchParameter |
Aliases: | wi |
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 |
輸入
Input types
若要查看此指令程式可接受的輸入類型,請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的,表示指令程式不接受輸入資料。
輸出
Output types
若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。