New-ComplianceSearchAction
內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 有些參數和設定可能是某一個環境所專屬。
使用 New-ComplianceSearchAction Cmdlet,在Exchange Server和Microsoft Purview 合規性入口網站中建立內容搜尋的動作。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
Syntax
New-ComplianceSearchAction
[-SearchName] <String[]>
[-Export]
[-ActionName <String>]
[-ArchiveFormat <ComplianceExportArchiveFormat>]
[-Confirm]
[-FileTypeExclusionsForUnindexedItems <String[]>]
[-EnableDedupe <Boolean>]
[-ExchangeArchiveFormat <ComplianceExportArchiveFormat>]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-IncludeSharePointDocumentVersions <Boolean>]
[-JobOptions <Int32>]
[-NotifyEmail <String>]
[-NotifyEmailCC <String>]
[-ReferenceActionName <String>]
[-Region <String>]
[-Report]
[-RetentionReport]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-Scope <ComplianceExportScope>]
[-SearchNames <String[]>]
[-SharePointArchiveFormat <ComplianceExportArchiveFormat>]
[-ShareRootPath <String>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>]
New-ComplianceSearchAction
[-SearchName] <String[]>
[-Preview]
[-ActionName <String>]
[-Confirm]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-JobOptions <Int32>]
[-ReferenceActionName <String>]
[-Region <String>]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-SearchNames <String[]>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>]
New-ComplianceSearchAction
[-SearchName] <String[]>
[-Purge]
[-PurgeType <ComplianceDestroyType>]
[-ActionName <String>]
[-Confirm]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-JobOptions <Int32>]
[-Region <String>]
[-ReferenceActionName <String>]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-SearchNames <String[]>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>]
Description
使用 New-ComplianceSearch Cmdlet 建立內容搜尋,並使用 Start-ComplianceSearch Cmdlet 執行它之後,您可以使用 New-ComplianceSearchAction Cmdlet 將搜尋動作指派給搜尋。
在內部部署 Exchange 中,此 Cmdlet 可在信箱搜尋角色中使用。 根據預設,此角色只會指派給探索管理角色群組。
您必須已獲指派權限,才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數,不過,如果某些參數並未包含在指派給您的權限中,您可能就無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 Find the permissions required to run any Exchange cmdlet。
在 Microsoft 365 中,您用來執行此 Cmdlet 的帳戶必須指派有效的 Microsoft 365 授權。
若要在安全 & 性合規性 PowerShell 中使用此 Cmdlet,您必須獲指派許可權。 如需詳細資訊,請參閱 Microsoft Purview 合規性入口網站中的權限。
範例
範例 1
New-ComplianceSearchAction -SearchName "Project X" -Preview
此範例會為名為 Project X 的內容搜尋建立預覽搜尋動作。
範例 2
New-ComplianceSearchAction -SearchName "Project X" -Export
此範例會為名為 Project X 的內容搜尋建立匯出搜尋動作。
範例 3
New-ComplianceSearchAction -SearchName "Remove Phishing Message" -Purge -PurgeType SoftDelete
此範例會刪除名為 Remove Phishing Message 的內容搜尋所傳回的搜尋結果。 請注意,當您使用 Purge 參數時,不會刪除未編制索引的專案。
範例 4
New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip -ExchangeArchiveFormat PerUserPst
此範例會匯出名為 「Case 321 All Sites」 的內容搜尋所傳回的結果。 搜尋結果會壓縮並匯出至單一 ZIP 檔案。 如果搜尋包含任何 Exchange 位置,則搜尋結果會匯出為每個信箱一個 PST 檔案。
參數
-ActionName
此參數只能在雲端式服務中使用。
ActionName 參數會指定內容搜尋動作的名稱。 只有當您在 SearchName 參數中指定多個內容搜尋時,才使用此參數。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-ArchiveFormat
此參數已過時,不再使用。
若要指定 Exchange 搜尋結果的格式,請使用 ExchangeArchiveFormat 參數。 若要指定 SharePoint 和 OneDrive 搜尋結果的格式,請使用 SharePointArchiveFormat 參數。
Type: | ComplianceExportArchiveFormat |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-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 2016, Exchange Server 2019, Security & Compliance |
-EnableDedupe
將保留此參數供 Microsoft 內部使用。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-ExchangeArchiveFormat
此參數只能在雲端式服務中運作。
此參數需要安全 & 性合規性 PowerShell 中的匯出角色。 根據預設,此角色只會指派給電子檔探索管理員角色群組。
ExchangeArchiveFormat 參數會指定如何匯出 Exchange 搜尋結果。 有效值為:
- PerUserPst:每個信箱一個 PST 檔案。
- SinglePst:包含所有匯出訊息的一個 PST 檔案。
- SingleFolderPst:一個 PST 檔案,其中包含整個匯出的單一根資料夾。
- IndividualMessage:將每個訊息匯出為 .msg 訊息檔案。 這是預設值。
- PerUserZip:每個信箱一個 ZIP 檔案。 每個 ZIP 檔案都包含從信箱匯出的 .msg 郵件檔案。
- SingleZip:所有信箱的一個 ZIP 檔案。 ZIP 檔案包含所有信箱中所有匯出的 .msg 郵件檔案。 此輸出設定僅適用于 PowerShell。
若要指定 SharePoint 和 OneDrive 搜尋結果的格式,請使用 SharePointArchiveFormat 參數。
Type: | ComplianceExportArchiveFormat |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Export
此參數只能在雲端式服務中運作。
此參數需要安全 & 性合規性 PowerShell 中的匯出角色。 根據預設,此角色只會指派給電子檔探索管理員角色群組。
匯出參數會指定內容搜尋的動作是匯出符合搜尋準則的完整結果集。 您不需要使用此參數指定值。
若只要傳回報表中每個偵測到之專案的相關資訊,請使用報表參數。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-FileTypeExclusionsForUnindexedItems
FileTypeExclusionsForUnindexedItems 會指定要排除的檔案類型,因為它們無法編制索引。 您可以指定多個以逗號分隔的值。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Force
Force 參數會隱藏警告或確認訊息。 您不需要使用此參數指定值。
在不適合提示系統管理員輸入的場合中,您可以使用此參數來利用程式設計方式執行工作。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Format
在安全 & 性合規性 PowerShell 中,此參數需要匯出角色。 根據預設,此角色只會指派給電子檔探索管理員角色群組。
Format 參數會指定當您使用 [匯出] 參數時,搜尋結果的格式。 有效值為:
- FxStream:匯出至 PST 檔案。 這是從Microsoft Purview 合規性入口網站匯出搜尋結果時唯一可用的選項。
- Mime:匯出至 .eml 訊息檔案。 這是當您使用 Cmdlet 匯出搜尋結果時的預設值。
- Msg:匯出至 .msg 訊息檔案。
Type: | ComplianceDataTransferFormat |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-IncludeCredential
IncludeCredential 參數會指定是否要在結果中包含認證。 您不需要使用此參數指定值。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-IncludeSharePointDocumentVersions
此參數只能在雲端式服務中使用。
IncludeSharePointDocumentVersions 參數會指定當您使用 Export 參數時,是否要匯出舊版的檔。 有效值為:
- $true:匯出檔的所有版本。
- $false:僅匯出目前已發佈的主題版本。 這是預設值。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-JobOptions
將保留此參數供 Microsoft 內部使用。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-NotifyEmail
在安全 & 性合規性 PowerShell 中,此參數需要匯出角色。 根據預設,這只會指派給電子檔探索管理員角色群組。
NotifyEmail 參數會在您使用 [匯出] 參數時,指定搜尋結果的電子郵件地址目標。
您指定的收件者位於郵件的 [收件者:] 欄位中。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-NotifyEmailCC
在安全 & 性合規性 PowerShell 中,此參數需要匯出角色。 根據預設,此角色只會指派給電子檔探索管理員角色群組。
NotifyEmailCC 參數會在您使用 Export 參數時,指定搜尋結果的電子郵件地址目標。
您指定的收件者位於郵件的 [副本:] 欄位中。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Preview
在安全 & 性合規性 PowerShell 中,此參數需要預覽角色。 根據預設,此角色只會指派給電子檔探索管理員角色群組。
預覽參數會指定內容搜尋的動作是預覽符合搜尋準則的結果。 您不需要使用此參數指定值。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Purge
注意:在安全 & 性合規性 PowerShell 中,此參數僅適用于搜尋和清除角色。 根據預設,此角色只會指派給組織管理和資料管理角色群組。
清除參數會指定內容搜尋的動作是移除符合搜尋準則的專案。 您不需要使用此參數指定值。
- 每個信箱一次可以移除最多 10 個項目。 因為搜尋和移除郵件的功能應該是事件回應工具,此限制可以協助確保從信箱快速移除郵件。 此動作並非用來清除使用者信箱。
- 您可以使用單一內容搜尋,從最多 50,000 個信箱中移除專案。 若要從超過 50,000 個信箱移除專案,您必須建立個別的內容搜尋。 如需詳細資訊,請 參閱搜尋和刪除 Microsoft 365 組織中的電子郵件訊息。
- 當您使用此參數時,不會從信箱中移除未編制索引的專案。
- PurgeType 參數的值會控制移除專案方式。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-PurgeType
注意:在安全 & 性合規性 PowerShell 中,此參數僅適用于搜尋和清除角色。 根據預設,此角色只會指派給組織管理和資料管理角色群組。
PurgeType 參數會指定如何在動作為 Purge 時移除專案。 有效值為:
- SoftDelete:使用者可復原已清除的專案,直到刪除的專案保留期限到期為止。
- 僅限) (雲端的 HardDelete:清除的專案會標示為永久移除信箱,並且會在下次由受管理資料夾助理處理信箱時永久移除。 如果在信箱上啟用單一專案復原,在刪除的專案保留期間到期之後,將會永久移除已清除的專案。
Type: | ComplianceDestroyType |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-ReferenceActionName
將保留此參數供 Microsoft 內部使用。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Region
將保留此參數供 Microsoft 內部使用。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Report
此參數只能在雲端式服務中運作。
報表參數會指定內容搜尋的動作是匯出有關結果的報表 (每個專案的相關資訊,而不是符合搜尋準則的完整結果) 集。 您不需要使用此參數指定值。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-RetentionReport
RetentionReport 參數會指定內容搜尋的動作是匯出保留報表。 您不需要使用此參數指定值。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-RetryOnError
RetryOnError 參數會指定是否要在任何失敗的專案上重試動作,而不重新執行整個動作。 您不需要使用此參數指定值。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Scenario
在安全 & 性合規性 PowerShell 中,此參數需要預覽角色。 根據預設,此角色只會指派給電子檔探索管理員角色群組。
當您使用 Export 參數時,Scenario 參數會指定案例類型。 有效值為:
- AnalyzeWithZoom:準備搜尋結果以在Microsoft Purview 電子檔探索進階版中處理。
- 一般:將搜尋結果匯出至本機電腦。 電子郵件會匯出至 .pst 檔案。 SharePoint 和商務用 OneDrive檔會以原生 Office 格式匯出。
- GenerateReportsOnly:
- 庫存:
- RetentionReports:
- TriagePreview:
Type: | ComplianceSearchActionScenario |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Scope
Scope 參數會指定當動作為 Export 時要包含的專案。 有效值為:
- IndexedItemsOnly
- UnindexedItemsOnly
- BothIndexedAndUnindexedItems
Type: | ComplianceExportScope |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-SearchName
SearchName 參數會指定要與內容搜尋動作相關聯之現有內容搜尋的名稱。 您可以指定多個以逗號分隔的內容搜尋。
您可以執行命令Get-ComplianceSearch來尋找內容搜尋 |Format-Table -Auto Name,Status。
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-SearchNames
此參數只能在雲端式服務中使用。
SearchNames 參數會指定要與內容搜尋動作相關聯之現有內容搜尋的名稱。 您會以逗號分隔內容搜尋名稱。
您可以執行命令Get-ComplianceSearch來尋找內容搜尋名稱 |Format-Table -Auto Name,Status。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-SharePointArchiveFormat
此參數只能在雲端式服務中運作。
此參數需要匯出角色。 根據預設,此角色只會指派給電子檔探索管理員角色群組。
SharePointArchiveFormat 參數會指定如何匯出 SharePoint 和 OneDrive 搜尋結果。 有效值為:
- IndividualMessage:匯出未壓縮的檔案。 這是預設值。
- PerUserZip:每個使用者一個 ZIP 檔案。 每個 ZIP 檔案都包含使用者匯出的檔案。
- SingleZip:適用于所有使用者的一個 ZIP 檔案。 ZIP 檔案包含所有使用者匯出的所有檔案。 此輸出設定僅適用于 PowerShell。
若要指定 Exchange 搜尋結果的格式,請使用 ExchangeArchiveFormat 參數。
Type: | ComplianceExportArchiveFormat |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-ShareRootPath
{{ 填入 ShareRootPath 描述 }}
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Version
將保留此參數供 Microsoft 內部使用。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-WhatIf
WhatIf 參數無法在安全 & 性合規性 PowerShell 中運作。
WhatIf 參數會模擬命令的動作。 使用此參數時,您不需要實際套用變更即可檢視可能會發生的變更。 您不需要使用此參數指定值。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |