Search-Mailbox
Этот командлет доступен только в локальной среде Exchange.
Командлет Search-Mailbox используется для поиска по почтовым ящикам и копирования результатов в указанный целевой почтовый ящик, удаления сообщений из исходного почтового ящика или обеих задач сразу.
Примечание. В облачных средах командлет Search-Mailbox устарел, а затем заменил New-ComplianceSearch и связанные с ним командлеты обнаружения электронных данных.
По умолчанию Search-Mailbox доступны только для ролей "Поиск почтовых ящиков" и "Импорт и экспорт почтовых ящиков", и эти роли не назначены ни одной группе ролей. Чтобы использовать этот командлет, необходимо добавить одну или обе роли в группу ролей (например, в группу ролей управления организацией). Только роль "Импорт и экспорт почтовых ящиков" предоставляет доступ к параметру DeleteContent. Дополнительные сведения о добавлении ролей в группы ролей см. в статье Добавление роли в группу ролей.
Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.
Синтаксис
Identity
Search-Mailbox
[-Identity] <MailboxOrMailUserIdParameter>
[-Confirm]
[-DeleteContent]
[-DomainController <Fqdn>]
[-DoNotIncludeArchive]
[-Force]
[-IncludeUnsearchableItems]
[-SearchDumpster]
[-SearchDumpsterOnly]
[-SearchQuery <String>]
[-WhatIf]
[<CommonParameters>]
EstimateResult
Search-Mailbox
[-Identity] <MailboxOrMailUserIdParameter>
[-EstimateResultOnly]
[-Confirm]
[-DomainController <Fqdn>]
[-DoNotIncludeArchive]
[-Force]
[-IncludeUnsearchableItems]
[-SearchDumpster]
[-SearchDumpsterOnly]
[-SearchQuery <String>]
[-WhatIf]
[<CommonParameters>]
Mailbox
Search-Mailbox
[-Identity] <MailboxOrMailUserIdParameter>
-TargetFolder <String>
-TargetMailbox <MailboxIdParameter>
[-Confirm]
[-DeleteContent]
[-DomainController <Fqdn>]
[-DoNotIncludeArchive]
[-Force]
[-IncludeUnsearchableItems]
[-LogLevel <LoggingLevel>]
[-LogOnly]
[-SearchDumpster]
[-SearchDumpsterOnly]
[-SearchQuery <String>]
[-WhatIf]
[<CommonParameters>]
Описание
Командлет Search-Mailbox можно использовать для поиска сообщений в заданном почтовом ящике и выполнения любой из следующих задач:
- Копирование сообщений в указанный целевой почтовый ящик.
- Удаление сообщений из исходного почтового ящика. Для удаления сообщений вам должна быть назначена роль управления экспортом и импортом почтовых ящиков.
- Выполнение восстановления отдельных элементов для восстановления элементов пользовательской папки "Элементы для восстановления".
- Очистка папки "Элементы для восстановления" в почтовом ящике при достижении жесткой квоты.
Примеры
Пример 1
Search-Mailbox -Identity "Joe Healy" -SearchQuery "Subject:Project Hamilton" -TargetMailbox "DiscoveryMailbox" -TargetFolder "JoeHealy-ProjectHamilton" -LogLevel Full
В этом примере производится поиск по почтовому ящику Joe Healy и копируются результаты поиска в почтовый ящик DiscoveryMailbox в папку JoeHealy-ProjectHamilton.
Пример 2
Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -TargetMailbox "administrator" -TargetFolder "SearchAndDeleteLog" -LogOnly -LogLevel Full
В этом примере ведется поиск по почтовому ящику April Stewart с отбором сообщений, содержащих фразу "Your bank statement" в теме; результаты заносятся в папку SearchAndDeleteLog почтового ящика администратора. В целевой почтовый ящик сообщения не копируются.
Пример 3
Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -DeleteContent
В этом примере ведется поиск по почтовому ящику April Stewart с отбором сообщений, содержащих фразу "Your bank statement" в теме; сообщения удаляются из исходного почтового ящика. Для использования параметра DeleteContent вам должна быть назначена роль управления экспортом и импортом почтовых ящиков.
Пример 4
Get-Mailbox | Search-Mailbox -SearchQuery 'election OR candidate OR vote' -TargetMailbox "Discovery Search Mailbox" -TargetFolder "AllMailboxes-Election" -LogLevel Full
В этом примере выполняется поиск всех почтовых ящиков в организации на наличие сообщений, содержащих слова "election", "candidate" или "vote" (выборы, кандидат, голосование). Результаты поиска копируются в почтовый ящик поиска в папке AllMailboxes-Election.
Параметры
-Confirm
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Переключатель подтверждения указывает, показывать или скрывать запрос подтверждения. То, как этот переключатель влияет на командлет, зависит от того, требует ли командлет подтверждения перед продолжением.
- Деструктивные командлеты (например, командлеты Remove-) имеют встроенную паузу, которая заставляет вас подтвердить команду перед продолжением. Можно пропускать запросы на подтверждение этих командлетов, используя следующий синтаксис:
-Confirm:$false. - Большинство других командлетов (например, командлеты New- и Set-) не имеют встроенной паузы. Для этих командлетов указание параметра Confirm без значения приводит к паузе, которая вынуждает вас подтвердить команду перед продолжением.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | cf |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-DeleteContent
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Примечание. Чтобы использовать этот переключатель, вам должна быть назначена роль "Управление импортом и экспортом почтовых ящиков". По умолчанию эта роль не назначена ни одной группе ролей (включая управление организацией). Как правило, роль назначается предопределенной или пользовательской группе ролей.
Параметр DeleteContent указывает, что сообщения, возвращаемые при поиске, должны быть безвозвратно удалены из исходного почтового ящика. С этим параметром не нужно указывать значение.
Когда вы используете этот переключатель с параметром TargetMailbox, сообщения копируются в целевой почтовый ящик и удаляются из исходного почтового ящика. Если задать для поиска уровень ведения журнала Basic или Full, следует указать целевой почтовый ящик и целевую папку, в которой будет создан журнал. Чтобы удалить сообщения из исходного ящика без копирования в целевой почтовый ящик, не задавайте значения параметров TargetMailbox, TargetFolder и LogLevel.
Перед использованием параметра DeleteContent для удаления содержимого рекомендуется проверить параметры подключения с помощью параметра LogOnly, как показано в примере 2.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Mailbox
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-DomainController
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, dc01.contoso.com.
Свойства параметров
| Тип: | Fqdn |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-DoNotIncludeArchive
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Параметр DoNotIncludeArchive указывает, что архивный почтовый ящик пользователя не должен включаться в поиск. С этим параметром не нужно указывать значение.
По умолчанию архивный почтовый ящик всегда включается в поиск.
Если для почтового ящика Exchange Online включена архивация с автоматическим расширением, поиск производится только в основном архивном почтовом ящике пользователя. Дополнительные архивные почтовые ящики не включаются в поиск.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-EstimateResultOnly
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Ключ EstimateResultOnly возвращает только приблизительное общее количество и размер сообщений. В целевой почтовый ящик сообщения не копируются. С этим параметром не нужно указывать значение.
Этот параметр невозможно использовать с параметром TargetMailbox.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
EstimateResult
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Force
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Переключатель "Принудительно" скрывает сообщения с предупреждениями или подтверждениями. Указывать значение для этого параметра необязательно.
Используйте этот переключатель, чтобы скрыть запрос на подтверждение, когда вы используете переключатель DeleteContent для окончательного удаления сообщений.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Identity
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Параметр Identity указывает идентификатор почтового ящика для поиска. Вы можете использовать любое значение, которое однозначно определяет почтовый ящик. Пример.
- Имя
- Псевдоним
- различающееся имя (DN);
- различающееся имя (DN);
- Домен\Имя пользователя
- Адрес электронной почты
- GUID
- LegacyExchangeDN
- SamAccountName
- Идентификатор пользователя или имя участника-пользователя
Свойства параметров
| Тип: | MailboxOrMailUserIdParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 1 |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-IncludeUnsearchableItems
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Переключатель IncludeUnsearchableItems включает в результаты поиска элементы, которые не могут быть проиндексированы с помощью поиска Exchange. С этим параметром не нужно указывать значение.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LogLevel
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Параметр LogLevel указывает уровень ведения журнала для поиска. Можно использовать одно из следующих значений:
- Подавление: журналы не ведутся.
- Базовый: сохраняются основные сведения о запросе и его выполнителе.
- Полный: в дополнение к сведениям, хранящимся на базовом уровне журнала, полный уровень журнала добавляет полный список результатов поиска.
Уровень журнала по умолчанию равен Basic.
При добавлении этого параметра создается сообщение электронной почты, которое отправляется в почтовый ящик, указанный в параметре TargetMailbox. Файл журнала (это файл CSV с именем Search Results.csv) вложен в это сообщение электронной почты и находится в папке, указанной параметром TargetFolder. В файле журнала содержится строка для каждого сообщения, включенного в результаты поиска при запуске командлета Search-Mailbox.
Свойства параметров
| Тип: | LoggingLevel |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Mailbox
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LogOnly
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Ключ LogOnly выполняет поиск, но только создает журнал. Сообщения, возвращенные в ходе поиска, не копируются в целевой почтовый ящик. С этим параметром не нужно указывать значение.
Уровень ведения журнала задается параметром LogLevel.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Mailbox
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SearchDumpster
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Ключ SearchDumpster определяет, следует ли включать папку Recoverable Items в поиск. В папке "Восстанавливаемые элементы" хранятся элементы, которые были удалены из папки "Удаленные" или жестко удаленные элементы до удаления из базы данных почтовых ящиков.
По умолчанию папка "Восстанавливаемые объекты" всегда включена в поиск. Чтобы исключить папку "Восстанавливаемые элементы" из поиска, используйте следующий синтаксис: -SearchDumpster:$false.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SearchDumpsterOnly
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Ключ SearchDumpsterOnly определяет, что поиск производится только в папке "Восстанавливаемые элементы" указанного почтового ящика. С этим параметром не нужно указывать значение.
В папке "Восстанавливаемые элементы" хранятся элементы, которые были удалены из папки "Удаленные" или жестко удаленные элементы до удаления из базы данных почтовых ящиков.
Также можно использовать этот параметр с параметром DeleteContent, чтобы удалить сообщения из этой папки и уменьшить ее размер.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SearchQuery
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Параметр SearchQuery определяет строку поиска или запрос, отформатированный с использованием язык KeyQL (KQL). Дополнительные сведения о KQL в Exchange см. в статье Свойства сообщения и операторы поиска для In-Place eDiscovery.
Если параметр не задан, возвращаются все сообщения.
Примечание. Командлет Search-Mailbox возвращает до 10000 результатов для каждого почтового ящика, если указан поисковый запрос.
Свойства параметров
| Тип: | String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-TargetFolder
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Параметр TargetFolder задает имя папка, в которой в целевом почтовом ящике сохраняются результаты поиска. Папка создается в целевом почтовом ящике после выполнения.
Свойства параметров
| Тип: | String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Mailbox
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-TargetMailbox
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Параметр TargetMailbox указывает почтовый ящик назначения, в котором копируются результаты поиска. Вы можете использовать любое значение, которое однозначно определяет почтовый ящик. Пример.
- Имя
- Псевдоним
- различающееся имя (DN);
- различающееся имя (DN);
- Домен\Имя пользователя
- Адрес электронной почты
- GUID
- LegacyExchangeDN
- SamAccountName
- Идентификатор пользователя или имя участника-пользователя
Этот параметр следует использовать вместе с параметром TargetFolder. Данный параметр невозможно использовать совместно с параметром EstimateResultOnly.
Свойства параметров
| Тип: | MailboxIdParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Mailbox
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-WhatIf
Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Переключатель WhatIf показывает, что команда делает без каких-либо изменений. С этим параметром не нужно указывать значение.
Свойства параметров
| Тип: | SwitchParameter |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | wi |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в статье about_CommonParameters.
Входные данные
Input types
Чтобы просмотреть типы входных данных, которые принимает этот командлет, см. Типы входных и выходных данных командлета. Если поле "Типы входных данных" для командлета пусто, командлет не принимает входные данные.
Выходные данные
Output types
Чтобы просмотреть типы возвращаемых данных, также называемые типами вывода, которые принимает этот командлет, см. раздел Типы ввода и вывода командлета. Если поле "Типы выходных данных" пусто, командлет не возвращает данные.