Set-MailboxSearch

Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и настройки могут отличаться в зависимости от среды.

Командлет Set-MailboxSearch используется для изменения существующего поиска в почтовом ящике.

Примечание. По состоянию на октябрь 2020 г. командлеты *-MailboxSearch не используются в Exchange Online PowerShell. Вместо этого используйте командлеты *-ComplianceSearch в PowerShell для соответствия требованиям безопасности & . Дополнительные сведения см. в статье Прекращение использования устаревших средств обнаружения электронных данных.

Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.

Синтаксис

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>]

Описание

В локальной среде Exchange поиск в почтовых ящиках используется для In-Place обнаружения электронных данных и In-Place удержания. Для обнаружения электронных данных и хранение на месте выполняется поиск по почтовым ящикам на всех серверах почтовых ящиков в организации, если не указано иного. Для создания удержания на месте необходимо указать почтовые ящики, которые необходимо поставить на удержание, с помощью параметра SourceMailboxes. Поиск может быть остановлен, запущен, изменен и удален.

По умолчанию поиск в почтовых ящиках выполняется на всех серверах почтовых ящиков Exchange 2013 или более поздних версий в организации, если вы не ограничиваете поиск меньшим количеством почтовых ящиков с помощью параметра SourceMailboxes. Чтобы выполнить поиск почтовых ящиков на серверах почтовых ящиков Exchange 2010, выполните команду на сервере Exchange 2010.

Если поиск для юридического предоставления электронных документов на месте, который необходимо изменить, уже запущен, следует его остановить, прежде чем использовать командлет Set-MailboxSearch. При повторном запуске поиска все предыдущие результаты поиска удаляются из целевого почтового ящика.

Дополнительные сведения см. в разделах Обнаружение электронных данных на месте в Exchange Server и Удержание на месте и хранение для судебного разбирательства в Exchange Server.

Для его запуска необходимо получить соответствующие разрешения. В этой статье перечислены все параметры командлета. Но некоторые из них могут быть вам не доступны, если они не включены в назначенные разрешения. Сведения о необходимых разрешениях для запуска командлетов и использования параметров в организации см. в статье 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

Переключатель подтверждения указывает, показывать или скрывать запрос подтверждения. Влияние этого параметра на командлет зависит от того, требуется ли командлету подтверждение перед выполнением.

  • Деструктивные командлеты (например, командлеты 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 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 указывает контроллер домена, который используется этим командлетом для чтения или записи данных в 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

Этот параметр доступен только в Exchange Server 2010.

Параметр 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 указывает дату окончания из диапазона дат.

Используйте формат короткой даты, определенный в настройках региональных параметров на компьютере, на котором выполняется команда. Например, если компьютер настроен на использование формата короткой даты мм / дд / гггг, введите 09/01/2018, чтобы указать 1 сентября 2018 года. Допускается ввод только даты или даты и времени. Если вы вводите дату и время дня, заключите это значение в кавычки ("), например," 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 позволяет исключить дубликаты почтовых ящиков во время поиска для юридического предоставления электронных документов на месте. Допустимые значения:

  • $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

Переключатель "Принудительно" скрывает сообщения с предупреждениями или подтверждениями. Указывать значение для этого параметра необязательно.

Используйте этот параметр, чтобы скрыть запрос подтверждения, указывающий, что предыдущие результаты поиска будут удалены из целевого почтового ящика и что поиск будет перезапущен.

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, исходного почтового ящика из поиска с помощью командлета Set-MailboxSearch и параметра SourceMailboxes, а в локальной среде Exchange все общедоступные папки из поиска удаляются с помощью командлета Set-MailboxSearch для изменения параметра 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 указывает языковой стандарт для поиска в почтовом ящике.

Допустимые входные данные для этого параметра — это поддерживаемое значение кода языка и региональных параметров из класса Майкрософт платформа .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
  • Электронная почта
  • "IM" (Обмен мгновенными сообщениями);
  • Журналы
  • Собрания
  • Примечания
  • Задачи

Вы можете указать несколько значений, разделив их запятыми.

Значение по умолчанию — $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

Этот параметр доступен только в Exchange Server 2010.

Параметр 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) и Запросы ключевых слов и условия поиска для обнаружения электронных данных.

Если этот параметр используется с другими параметрами поискового запроса, они объединяются с помощью оператора 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);
  • Каноническое краткое имя
  • GUID

Update Если значения содержат пробелы или иным образом требуют кавычек, используйте следующий синтаксис: "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 указывает дату начала из диапазона дат.

Используйте формат короткой даты, определенный в настройках региональных параметров на компьютере, на котором выполняется команда. Например, если компьютер настроен на использование формата короткой даты мм / дд / гггг, введите 09/01/2018, чтобы указать 1 сентября 2018 года. Допускается ввод только даты или даты и времени. Если вы вводите дату и время дня, заключите это значение в кавычки ("), например," 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

Параметр StatisticsStartIndex используется Центром администрирования Exchange (EAC) для получения статистики по ключевым словам в постраничной операции.

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);
  • Каноническое краткое имя
  • GUID

Update Если значения содержат пробелы или иным образом требуют кавычек, используйте следующий синтаксис: "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);
  • Домен\Имя пользователя
  • Адрес электронной почты
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • Идентификатор пользователя или имя участника-пользователя
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

Сведения о типах возвращаемых данных, которые также называются типами выходных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип вывода пусто, командлет не возвращает данные.