Командлет Get-Recipient используется для возврата списка объектов получателей из службы каталогов Active Directory.

Синтаксис

get-Recipient [-Identity <RecipientIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]
get-Recipient [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]
get-Recipient [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

Параметры

Параметр Обязательный Тип Описание

Anr

Дополнительно

System.String

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

  • CommonName (CN)

  • DisplayName (displayName)

  • FirstName (givenName)

  • LastName (sn)

  • Alias (mailNickname)

Credential

Дополнительно

System.Management.Automation.PSCredential

Параметр Credential указывает имя пользователя и пароль, который нужно использовать для доступа к Active Directory.

Если используется параметр Credential, для продолжения команда предлагает ввести пароль учетной записи.

DomainController

Дополнительно

Microsoft.Exchange.Data.Fqdn

Чтобы указать полное доменное имя (FQDN) контроллера домена, записывающего это изменение конфигурации в Active Directory, включите в команду параметр DomainController.

Filter

Дополнительно

System.String

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

Дополнительные сведения о фильтруемых свойствах см. в разделе Фильтруемые свойства для параметра -Filter.

Идентификатор

Дополнительно

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

Параметр Identity идентифицирует получателя. Можно использовать одно из следующих значений:

  • GUID;

  • Domain\Account

  • Имя участника-пользователя

  • LegacyExchangeDN

  • SMTP-адрес

  • Имя

  • псевдоним.

OrganizationalUnit

Дополнительно

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

Параметр OrganizationalUnit указывает имя подразделения или каноническое имя домена и используется для ограничения результатов. При использовании этого параметра будут получены только получатели в указанном контейнере. Например:

  • Подразделение: westcoast.contoso.com/users

  • Домен: westcoast.contoso.com

ReadFromDomainController

Дополнительно

System.Management.Automation.SwitchParameter

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

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

RecipientType

Дополнительно

Microsoft.Exchange.Data.Directory.Recipient.RecipientType[]

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

  • UserMailbox

  • MailUser

  • MailContact

  • MailUniversalDistributionGroup

  • MailUniversalSecruityGroup

  • MailNonUniversalGroup

  • DynamicDistributionGroup

  • PublicFolder

RecipientTypeDetails

Дополнительно

Microsoft.Exchange.Data.Directory.Recipient.RecipientTypeDetails[]

Параметр RecipientTypeDetails указывает тип возвращаемых получателей. Типы получателей в Microsoft Exchange Server 2007 разделены на типы и подтипы. Каждый тип получателя содержит все общие свойства всех подтипов. Например, тип UserMailbox представляет учетную запись пользователя в Active Directory со связанным почтовым ящиком. Так как имеется несколько типов почтовых ящиков, каждый тип идентифицирован с помощью параметра RecipientTypeDetails. Например, для почтового ящика конференц-зал для параметра RecipientTypeDetails установлено значение ConferenceRoomMailbox, в то время как для почтового ящика пользователя для параметра RecipientTypeDetails установлено значение UserMailbox.

Для этой команды доступны следующие детали типов получателей:

  • ConferenceRoomMailbox

  • EquipmentMailbox

  • LegacyMailbox

  • LinkedMailbox

  • UserMailbox

  • MailContact

  • DynamicDistributionGroup

  • MailForestContact

  • MailNonUniversalGroup

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailUser

  • PublicFolder

  • SharedMailbox

ResultSize

Дополнительно

Microsoft.Exchange.Data.Unlimited

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

SortBy

Дополнительно

System.String

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

  • псевдоним.

  • DisplayName

  • Имя

Результаты сортируются в порядке возрастания.

Подробное описание

Командлет Get-Recipient позволяет получить атрибуты определенного получателя. Никакие параметры не являются обязательными. Если командлет выполняется без параметров, возвращается полный список получателей для организации.

Для выполнения командлета Get-Recipient используемой учетной записи необходимо делегировать следующую роль:

  • роль администратора Exchange с правами на просмотр.

Дополнительные сведения о разрешениях, делегировании ролей и правах, необходимых для администрирования Exchange Server 2007, см. в разделе Вопросы, связанные с разрешениями.

Типы входных данных

Типы возвращаемых данных

Ошибки

Ошибка Описание

   

 

Исключения

Исключения Описание

  

 

Пример

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

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

Копировать код
Get-Recipient -ResultSize unlimited
Get-Recipient -RecipientType DynamicDistributionGroup -SortBy Name