New-ComplianceSearchAction
Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и настройки могут отличаться в зависимости от среды.
Используйте командлет New-ComplianceSearchAction для создания действий для поиска содержимого в Exchange Server и в Портал соответствия требованиям Microsoft Purview.
Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.
Синтаксис
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>] Описание
После создания поиска контента с помощью командлета New-ComplianceSearch и его запуска с помощью командлета Start-ComplianceSearch вы назначите действие поиска поиску с помощью командлета New-ComplianceSearchAction.
В локальной среде Exchange этот командлет доступен в роли поиска почтовых ящиков. По умолчанию эта роль назначается только группе ролей Управление обнаружением.
Для его запуска необходимо получить соответствующие разрешения. В этой статье перечислены все параметры командлета. Но некоторые из них могут быть вам не доступны, если они не включены в назначенные разрешения. Сведения о необходимых разрешениях для запуска командлетов и использования параметров в организации см. в статье Find the permissions required to run any Exchange cmdlet.
В Microsoft 365 учетной записи, используемой для выполнения этого командлета, должна быть назначена действительная лицензия Microsoft 365.
Чтобы использовать этот командлет в PowerShell для соответствия требованиям безопасности & , необходимо назначить разрешения. Дополнительные сведения см. в статье Разрешения на портале соответствия требованиям 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В этом примере экспортируются результаты, возвращаемые поиском контента с именем "Вариант 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
Переключатель подтверждения указывает, показывать или скрывать запрос подтверждения. Влияние этого параметра на командлет зависит от того, требуется ли командлету подтверждение перед выполнением.
- Деструктивные командлеты (например, командлеты 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 2016, Exchange Server 2019, Security & Compliance |
-EnableDedupe
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
| 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 для соответствия требованиям безопасности & . По умолчанию эта роль назначается только группе ролей Диспетчер обнаружения электронных данных.
Параметр Экспорт указывает действие для поиска контента— экспортировать полный набор результатов, соответствующих условиям поиска. Указывать значение для этого параметра необязательно.
Чтобы возвратить только сведения о каждом обнаруженном элементе в отчете, используйте параметр 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 |
-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
Переключатель "Принудительно" скрывает сообщения с предупреждениями или подтверждениями. Указывать значение для этого параметра необязательно.
Этот параметр можно применять для программного выполнения задач, не требующего вмешательства администратора.
| 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 определяет формат результатов поиска при использовании параметра Export. Допустимые значения:
- FxStream: экспорт в PST-файлы. Это единственный вариант, доступный при экспорте результатов поиска из Портал соответствия требованиям Microsoft Purview.
- Mime: экспорт в EML-файлы сообщений. Это значение по умолчанию при использовании командлетов для экспорта результатов поиска.
- 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
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
| 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 указывает целевой адрес электронной почты для результатов поиска при использовании параметра Export.
Получатель указывается в поле сообщения To:.
| 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.
Получатель указывается в поле сообщения Cc:.
| 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 для соответствия требованиям безопасности & этот параметр доступен только в роли Поиска и очистки. По умолчанию эта роль назначается только группам ролей "Управление организацией" и "Следователь данных".
Параметр Purge указывает, что действие для поиска контента заключается в удалении элементов, соответствующих условиям поиска. Указывать значение для этого параметра необязательно.
- За один раз можно удалить не более 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
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
| 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
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
| 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 для обеспечения соответствия требованиям безопасности & для этого параметра требуется роль предварительной версии. По умолчанию эта роль назначается только группе ролей Диспетчер обнаружения электронных данных.
Параметр Scenario определяет тип сценария при использовании параметра Export переключения. Допустимые значения:
- AnalyzeWithZoom: подготовьте результаты поиска для обработки в eDiscovery премиум 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
{{ Fill ShareRootPath Description }}
| 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
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
| 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 |