Get-MailPublicFolder

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

Командлет Get-MailPublicFolder используется для получения связанных с электронной почтой сведений только об общих почтовых папках. Если нужны сведения о базовых, не связанных с почтой, настройках общих почтовых папок, используйте другой командлет — Get-PublicFolder.

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

Синтаксис

Get-MailPublicFolder
   [-Anr <String>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-ReadFromDomainController]
   [-ResultSize <Unlimited>]
   [-Server <ServerIdParameter>]
   [-SortBy <String>]
   [<CommonParameters>]
Get-MailPublicFolder
   [[-Identity] <MailPublicFolderIdParameter>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-ReadFromDomainController]
   [-ResultSize <Unlimited>]
   [-Server <ServerIdParameter>]
   [-SortBy <String>]
   [<CommonParameters>]

Описание

Для его запуска необходимо получить соответствующие разрешения. В этой статье перечислены все параметры командлета. Но некоторые из них могут быть вам не доступны, если они не включены в назначенные разрешения. Сведения о необходимых разрешениях для запуска командлетов и использования параметров в организации см. в статье Find the permissions required to run any Exchange cmdlet.

Примеры

Пример 1

Get-MailPublicFolder -ResultSize 100 | Format-List

В этом примере возвращаются сведения об общих почтовых папках, число которых не превышает 100. В этом примере результат команды Get-MailPublicFolder передается на вход команды Format-List, чтобы результат содержал все доступные сведения.

Пример 2

Get-MailPublicFolder -Identity \Marketing\Reports

В этом примере возвращаются сведения об общей почтовой папке Reports, которая находится в общей папке верхнего уровня Marketing.

Пример 3

Get-MailPublicFolder -Anr Marketing*

В этом примере возвращаются сведения обо всех общих почтовых папках, имя которых начинается со слова Marketing, с помощью параметра Anr.

Параметры

-Anr

Параметр Anr определяет строку, по которой будет выполнен поиск с разрешением неоднозначных имен (ANR). Можно задать частичное строковое значение и выполнить поиск объектов с атрибутом, который совпадает с этой строкой. По умолчанию искомыми атрибутами являются:

  • CommonName (CN)
  • DisplayName
  • FirstName
  • LastName
  • Alias (Псевдоним)
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

-Credential

Параметр Credential указывает имя пользователя и пароль, используемые для выполнения этой команды. Как правило, этот параметр используется в сценариях, или если требуется указывать различные учетные данные, которые предоставляют необходимые разрешения.

Для значения этого параметра требуется командлет Get-Credential. Чтобы приостановить эту команду и получить приглашение для ввода учетных данных, используйте значение (Get-Credential). Или перед выполнением этой команды сохраните учетные данные в переменной (например,$cred = Get-Credential), а затем используйте имя переменной ($cred) для этого параметра. Для получения дополнительной информации см. Get-Credential.

Type:PSCredential
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

-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

-Filter

Параметр Filter использует синтаксис OPATH для фильтрации результатов по указанным свойствам и значениям. Для критериев поиска используется следующий синтаксис: "Property -ComparisonOperator 'Value'".

  • Заключите весь фильтр OPATH в двойные кавычки "". Если фильтр содержит системные значения (например, $true, $false или $null), используйте одиночные кавычки ' '. Хотя этот параметр является строкой (а не системным блоком), вы также можете использовать фигурные скобки { }, но только если фильтр не содержит переменные.
  • Property — это свойство с поддержкой фильтрации. Дополнительные сведения о фильтруемых свойствах в Exchange Server и Exchange Online см. в разделе Фильтруемые свойства для параметра Filter.
  • ComparisonOperator — это оператор сравнения OPATH (например -eq , для равных и -like для сравнения строк). Подробнее об операторах сравнения см. в статье about_Comparison_Operators.
  • Value — это значение свойства для поиска. Заключите текстовые значения и переменные в одиночные кавычки ('Value' или '$Variable'). Если значение переменной содержит одиночные кавычки, необходимо определить (избежать) одиночные кавычки, чтобы правильно развернуть переменную. Например, вместо '$User' используйте '$($User -Replace "'","''")'. Не заключайте целые числа или системные значения в кавычки (например, используйте 500, $true, $false, или $null вместо них).

Можно связать несколько условий поиска вместе с помощью логических операторов -and и -or. Например, "Criteria1 -and Criteria2" или "(Criteria1 -and Criteria2) -or Criteria3".

Подробные сведения о фильтрах OPATH в Exchange см. в разделе Дополнительные сведения о синтаксисе OPATH.

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

-Identity

Параметр Identity определяет идентификатор GUID или имя общей папки, представляющие определенную общую папку. Также можно включить путь в формате \общая_папка_верхнего_уровня\общая_папка.

Можно опустить метку параметра, оставив только имя общей папки или GUID.

Type:MailPublicFolderIdParameter
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-IgnoreDefaultScope

Параметр IgnoreDefaultScope указывает команде игнорировать параметр области получателя по умолчанию для сеанса Exchange PowerShell и использовать в качестве области весь лес. Для этого переключателя не требуется указывать значение.

Этот параметр позволяет команде получать доступ к объектам Active Directory, которые в настоящее время недоступны в области по умолчанию, но также вводит следующие ограничения:

  • При этом параметр DomainController использовать нельзя. Команда автоматически использует соответствующий сервер глобального каталога.
  • При этом параметр DomainController использовать нельзя. Команда автоматически использует соответствующий сервер глобального каталога.
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

-ReadFromDomainController

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

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

Для Set-AdServerSettings -ViewEntireForest $true включения всех объектов в лесу требуется параметр ReadFromDomainController. В противном случае команда может использовать глобальный каталог, содержащий устаревшие сведения. Кроме того, для получения сведений может потребоваться выполнить несколько итераций команды с параметром ReadFromDomainController.

По умолчанию в качестве области получателя задается домен, в котором размещаются серверы Exchange.

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

-ResultSize

Параметр ResultSize указывает максимальное число возвращаемых результатов. Если требуется возвратить все результаты, отвечающие условиям запроса, используйте для этого параметра значение unlimited. Значение по умолчанию — 1000.

Type:Unlimited
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

-Server

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

Параметр Server фильтрует результаты по указанному серверу Exchange Server. Можно использовать любое значение, однозначно определяющее сервер. Примеры:

  • Имя.
  • полное доменное имя;
  • различающееся имя (DN);
  • Устаревшее различающееся имя Exchange
Type:ServerIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010

-SortBy

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

Если в представлении по умолчанию нет свойства, по которым выполняется сортировка, можно добавить команду с | Format-Table -Auto Property1,Property2,...PropertyXпомощью . , чтобы создать новое представление, содержащее все свойства, которые нужно просмотреть. В именах свойств поддерживаются подстановочные знаки (*).

Можно выполнять сортировку по следующим свойствам:

  • Имя
  • DisplayName
  • Alias (Псевдоним)
  • Id
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

Входные данные

Input types

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

Выходные данные

Output types

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