Set-ComplianceSearch
內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 某些參數和設定可能僅限於一個環境或另一個環境。
使用 Set-ComplianceSearch Cmdlet 修改 Exchange Server 2016 或更新版本以及Microsoft Purview 合規性入口網站中的非執行中合規性搜尋。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
注意事項
在雲端中,此 Cmdlet 具有下列需求:
- (2025 年 8 月) 的 Exchange Online PowerShell 模組版本 3.9.0 或更新版本。
- 執行 Connect-IPPSSession 命令連線至安全性 & 合規性 PowerShell 時,請使用 EnableSearchOnlySession 參數。
語法
Default (預設值)
Set-ComplianceSearch
[-Identity] <ComplianceSearchIdParameter>
[-AddExchangeLocation <String[]>]
[-AddExchangeLocationExclusion <String[]>]
[-AddSharePointLocation <String[]>]
[-AddSharePointLocationExclusion <String[]>]
[-AllowNotFoundExchangeLocationsEnabled <Boolean>]
[-Confirm]
[-ContentMatchQuery <String>]
[-Description <String>]
[-ExchangeLocation <String[]>]
[-ExchangeLocationExclusion <String[]>]
[-Force]
[-HoldNames <String[]>]
[-IncludeOrgContent <Boolean>]
[-IncludeUserAppContent <Boolean>]
[-Language <CultureInfo>]
[-Name <String>]
[-PublicFolderLocation <String[]>]
[-RefinerNames <String[]>]
[-RemoveExchangeLocation <String[]>]
[-RemoveExchangeLocationExclusion <String[]>]
[-RemovePublicFolderLocation <String[]>]
[-RemoveSharePointLocation <String[]>]
[-RemoveSharePointLocationExclusion <String[]>]
[-SharePointLocation <String[]>]
[-SharePointLocationExclusion <String[]>]
[-WhatIf]
[<CommonParameters>]
Description
您必須已獲指派權限,才能執行此指令程式。 雖然本文列出 Cmdlet 的所有參數,但如果指派給您的權限中未包含某些參數,您可能無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 Find the permissions required to run any Exchange cmdlet。
在內部部署 Exchange 中,此 Cmdlet 可在信箱搜尋角色中使用。 根據預設,這個角色只會指派給探索管理角色群組。
若要在安全性與合規性 PowerShell 中使用此 Cmdlet,您必須獲得指派權限。 如需詳細資訊,請參閱 Microsoft Purview 合規性入口網站中的權限。
範例
範例 1
Set-ComplianceSearch -Identity "Project X" -ExchangeLocation All
本範例會變更名為 Project X 的現有合規性搜尋。Exchange 搜尋的範圍已變更為 [所有信箱]。
範例 2
Set-ComplianceSearch -Identity "Contoso Case Search 1" -HoldNames All -ExchangeLocation $null -SharePointLocation $null
本範例會變更與 Microsoft Purview 合規性入口網站中電子文件探索案例相關聯的現有合規性搜尋。 搜尋的範圍會從搜尋選取的信箱和 SharePoint 網站,變更為搜尋電子文件探索案例中已保留的所有內容位置。
範例 3
Set-ComplianceSearch -Identity "China Subsidiary Search" -Language zh-CN
此範例會將現有合規性搜尋的語言設定變更為中文。
如果您在 ContentMatchQuery 參數) 中指定的搜尋查詢 (中使用非英文關鍵字,則可能需要變更語言設定。
參數
-AddExchangeLocation
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
AddExchangeLocation 參數會指定當您未針對 ExchangeLocation 參數使用值 [全部] 時,要新增至所包含信箱清單的信箱。 有效值為:
- 一般使用者信箱。 包括其他類型的信箱 (例如非作用中信箱或 Microsoft 365 來賓使用者) 是由 AllowNotFoundExchangeLocationsEnabled 參數控制。
- 信箱
若要指定信箱或通訊群組,請使用電子郵件地址。 您可以指定多個以逗號分隔的值。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AddExchangeLocationExclusion
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
此參數只能在內部部署 Exchange 中運作。
當您針對 ExchangeLocation 參數使用值 All 時,此參數會指定要新增至排除信箱清單的信箱。 有效值為:
- 一般使用者信箱。 包括其他類型的信箱 (例如非作用中信箱或 Microsoft 365 來賓使用者) 是由 AllowNotFoundExchangeLocationsEnabled 參數控制。
- 信箱
若要指定信箱或通訊群組,請使用電子郵件地址。 您可以指定多個以逗號分隔的值。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AddSharePointLocation
適用對象:安全性 & 合規性
此參數只能在雲端式服務中使用。
AddSharePointLocation 參數會指定當您未針對 SharePointLocation 參數使用「全部」值時,要新增至包含網站清單的 SharePoint 網站。 您可以依據其 URL 值識別網站。
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AddSharePointLocationExclusion
適用對象:安全性 & 合規性
此參數只能在雲端式服務中使用。
將保留此參數供 Microsoft 內部使用。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AllowNotFoundExchangeLocationsEnabled
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
AllowNotFoundExchangeLocationsEnabled 參數會指定是否要在合規性搜尋中包括一般使用者信箱以外的信箱。 有效值為:
- $true:搜尋不會在繼續之前嘗試驗證信箱的存在。 如果要搜尋解析為一般信箱的信箱,則此值為必要。
- $false:搜尋會先嘗試驗證信箱是否存在,再繼續進行。 如果您指定的信箱不是一般使用者信箱,搜尋將會失敗。 此值為預設值。
受此參數值影響的信箱類型包括:
- 非使用中的信箱
- 沒有 Exchange Online 授權但使用 Office 應用程式的使用者
- 來賓使用者
- 身分識別與您的 Microsoft 365 組織同步的內部部署使用者
參數屬性
| 類型: | Boolean |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Confirm
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
Confirm 參數會指定要顯示或隱藏確認提示。 此參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續。
- 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停,它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:
-Confirm:$false。 - 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 針對這些 Cmdlet,指定不帶值的 Confirm 參數會造成暫停,強制您在繼續之前先確認命令。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | CF |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ContentMatchQuery
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
ContentMatchQuery 參數會指定內容搜尋篩選器。
此參數使用利用關鍵字查詢語言 (KQL) 格式化的文字搜尋字串或查詢。 如需詳細資訊,請參閱 關鍵字查詢語言 (KQL) 語法參考和電子文件探索的關鍵字查詢和搜尋條件。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Description
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
Description 參數會指定符合性搜尋的描述。 如果值包含空格,請使用引號括住值。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ExchangeLocation
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
ExchangeLocation 參數會指定要包含的信箱。 有效值為:
- 一般使用者信箱。 包括其他類型的信箱 (例如非作用中信箱或 Microsoft 365 來賓使用者) 是由 AllowNotFoundExchangeLocationsEnabled 參數控制。
- 信箱
- 所有信箱的值 [全部]。 您只能單獨使用此值。
若要指定信箱或通訊群組,請使用電子郵件地址。 您可以指定多個以逗號分隔的值。
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ExchangeLocationExclusion
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
此參數只能在內部部署 Exchange 中運作。
當您針對 ExchangeLocation 參數使用值 All 時,此參數會指定要排除的信箱。 有效值為:
- 一般使用者信箱。 包括其他類型的信箱 (例如非作用中信箱或 Microsoft 365 來賓使用者) 是由 AllowNotFoundExchangeLocationsEnabled 參數控制。
- 信箱
若要指定信箱或通訊群組,請使用電子郵件地址。 您可以指定多個以逗號分隔的值。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Force
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
強制開關會隱藏警告或確認訊息。 您不需要使用此參數指定值。
在不適合提示系統管理員輸入的場合中,您可以使用此參數來利用程式設計方式執行工作。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-HoldNames
適用對象:安全性 & 合規性
此參數只能在雲端式服務中使用。
HoldNames 參數會指定搜尋在指定的電子文件探索案例中保留的內容位置。 您對這個參數使用值 All。 您可以只對與 eDiscovery 案例相關聯的符合性搜尋使用這個參數。
如果合規性搜尋中的內容位置包括信箱,您也需要使用具有值$null的 ExchangeLocation 參數。 同樣地,如果合規性搜尋包括 SharePoint 網站,您也需要使用 SharePointLocation 參數搭配值$null。
此外,如果內容位置已置於查詢型案例保留狀態,則重新啟動此合規性搜尋時,只會搜尋保留中的項目。 例如,如果使用者放在查詢式案例保留,保留特定日期之前已傳送或已建立的項目,則只有這些項目會藉由使用這個符合性搜尋指定的搜尋準則進行搜尋。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Identity
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
Identity 參數會指定要修改的符合性搜尋。
當您使用這個參數時,必須使用 Identity 參數,但會忽略其值。 例如,針對 Identity 參數使用 000 這個值。
- 名稱
- JobRunId (GUID)
JobRunId (GUID)
參數屬性
| 類型: | ComplianceSearchIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-IncludeOrgContent
適用對象:安全性 & 合規性
{{ Fill IncludeOrgContent 描述 }}
參數屬性
| 類型: | Boolean |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-IncludeUserAppContent
適用對象:安全性 & 合規性
此參數只能在雲端式服務中使用。
IncludeUserAppContent 參數可指定您要針對組織中沒有一般 Microsoft 365 使用者帳戶的使用者搜尋雲端式儲存位置。 這些類型的使用者包括使用 Office 應用程式的沒有 Exchange Online 授權的使用者、Microsoft 365 來賓使用者,以及身分識別與 Microsoft 365 組織同步處理的內部部署使用者。 有效值為:
- $true:搜尋中包含任何 Exchange 位置參數中指定之使用者的雲端式儲存位置。 如果您針對 ExchangeLocation 參數使用值 All,搜尋中會包含任何來賓或內部部署使用者的雲端式儲存位置。
- $false:ExchangeLocation 參數中指定之使用者的雲端式儲存位置不會包含在搜尋中。 此值為預設值。
參數屬性
| 類型: | Boolean |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Language
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
Language 參數會指定符合性搜尋的語言。
此參數的有效輸入是來自 Microsoft .NET Framework CultureInfo 類別的支援文化代碼值。 例如,丹麥文為 da-DK 或日文為 ja-JP。 如需詳細資訊,請參閱 CultureInfo 類別。
參數屬性
| 類型: | CultureInfo |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
將保留此參數供 Microsoft 內部使用。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PublicFolderLocation
適用對象:安全性 & 合規性
此參數只能在雲端式服務中使用。
PublicFolderLocation 參數指定您要在搜尋中包含所有的公用資料夾。 您可對此參數使用 All 值。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RefinerNames
適用對象:安全性 & 合規性
此參數只能在雲端式服務中使用。
將保留此參數供 Microsoft 內部使用。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RemoveExchangeLocation
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
RemoveExchangeLocation 參數會指定當您未針對 ExchangeLocation 參數使用 [全部] 值時,要從包含的信箱清單中移除的信箱。 有效值為:
- 當您針對 ExchangeLocation 參數使用 All 值時,此參數會指定要從排除信箱清單中移除的信箱。有效值為:
- 信箱
若要指定信箱或通訊群組,請使用電子郵件地址。 您可以指定多個以逗號分隔的值。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RemoveExchangeLocationExclusion
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
此參數只能在內部部署 Exchange 中運作。
當您針對 ExchangeLocation 參數使用值 All 時,此參數會指定要從排除的信箱清單中移除的信箱。 有效值為:
- 當您針對 ExchangeLocation 參數使用 All 值時,此參數會指定要從排除信箱清單中移除的信箱。有效值為:
- 信箱
若要指定信箱或通訊群組,請使用電子郵件地址。 您可以指定多個以逗號分隔的值。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RemovePublicFolderLocation
適用對象:安全性 & 合規性
此參數只能在雲端式服務中使用。
將保留此參數供 Microsoft 內部使用。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RemoveSharePointLocation
適用對象:安全性 & 合規性
此參數只能在雲端式服務中使用。
RemoveSharePointLocation 參數會指定當您未針對 SharePointLocation 參數使用「全部」值時,要從包含網站清單中移除的 SharePoint 網站。 您可以依據其 URL 值識別網站。
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RemoveSharePointLocationExclusion
適用對象:安全性 & 合規性
此參數只能在雲端式服務中使用。
將保留此參數供 Microsoft 內部使用。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-SharePointLocation
適用對象:安全性 & 合規性
此參數只能在雲端式服務中使用。
SharePointLocation 參數會指定要包含的 SharePoint 網站。 您依據其 URL 值識別網站,或者您可以使用 All 值以包含所有網站。
您可以輸入多個以逗號分隔的值。 如果這些值包含空格或需要引號,請使用下列語法: "Value1","Value2",..."ValueN"。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-SharePointLocationExclusion
適用對象:安全性 & 合規性
此參數只能在雲端式服務中使用。
將保留此參數供 Microsoft 內部使用。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
適用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合規性
WhatIf 開關無法在安全性與合規性 PowerShell 中使用。
WhatIf 參數會顯示命令在不進行任何變更的情況下執行的動作。 您不需要使用此參數指定值。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | WI |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援常見參數: -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。