Применимо к: Exchange Server 2010 SP1

Последнее изменение раздела: 2011-04-21

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

Синтаксис

Get-Recipient [-Identity <RecipientIdParameter>] [-AuthenticationType <Managed | Federated>] [-BookmarkDisplayName <String>] [-Capabilities <MultiValuedProperty>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-IncludeBookmarkObject <$true | $false>] [-Organization <OrganizationIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-PropertySet <All | ControlPanel | ConsoleSmallSet | ConsoleLargeSet | Minimum>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]
Get-Recipient [-AuthenticationType <Managed | Federated>] [-Capabilities <MultiValuedProperty>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-PropertySet <All | ControlPanel | ConsoleSmallSet | ConsoleLargeSet | Minimum>] [-ReadFromDomainController <SwitchParameter>] [-RecipientPreviewFilter <String>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]
Get-Recipient [-Anr <String>] [-AuthenticationType <Managed | Federated>] [-Capabilities <MultiValuedProperty>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-PropertySet <All | ControlPanel | ConsoleSmallSet | ConsoleLargeSet | Minimum>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

Параметры

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

Anr

Необязательный

System.String

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

  • CommonName (CN)

  • DisplayName

  • FirstName

  • LastName

  • Alias

AuthenticationType

Необязательный

Microsoft.Exchange.Data.Directory.AuthenticationType

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

Параметр AuthenticationType указывает получателя по типу проверки подлинности. Используйте одно из следующих значений:

  • Federated

  • Managed

BookmarkDisplayName

Необязательный

System.String

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Capabilities

Необязательный

Microsoft.Exchange.Data.MultiValuedProperty

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Credential

Необязательный

System.Management.Automation.PSCredential

Для этого параметра требуется создание и передача объекта учетных данных. Этот объект учетных данных создается с помощью командлета Get-Credential. Дополнительные сведения см. в разделе Get-Credential.

DomainController

Необязательный

Microsoft.Exchange.Data.Fqdn

Параметр DomainController указывает имя FQDN контроллера домена, получающего данные из Служба каталогов Active Directory.

Filter

Необязательный

System.String

Параметр Filter указывает фильтр OPath, используемый для фильтрации получателей.

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

Identity

Необязательный

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

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

  • GUID

  • Домен\Учетная_запись

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

  • LegacyExchangeDN

  • SMTP-адрес

  • Name

  • Alias

  • Различающееся имя (DN)

IgnoreDefaultScope

Необязательный

System.Management.Automation.SwitchParameter

Параметр IgnoreDefaultScope указывает, что при выполнении команды необходимо игнорировать параметр, определяющий для сеанса командной консоли Exchange область получателя по умолчанию, и задает в качестве области действия весь лес. Это обеспечивает команде доступ к объектам Служба каталогов Active Directory, которые на текущий момент не относятся к области действия по умолчанию. Для параметра IgnoreDefaultScope действуют следующие ограничения.

  • При этом параметр DomainController использовать нельзя. Команда автоматически использует соответствующий сервер глобального каталога.

  • В качестве значения параметра Identity можно использовать только различающееся имя. Другие формы идентификации, например с помощью псевдонима или идентификатора GUID, не допускаются.

  • Невозможно использовать параметры OrganizationalUnit и Identity вместе.

  • При этом параметр Credential использовать нельзя.

IncludeBookmarkObject

Необязательный

System.Boolean

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Organization

Необязательный

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

Этот параметр доступен для развертываний с несколькими клиентами В случае локального развертывания он недоступен. Дополнительные сведения о развертывании с несколькими клиентами см. в разделе Multi-Tenant Support.

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

OrganizationalUnit

Необязательный

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

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

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

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

PropertySet

Необязательный

Microsoft.Exchange.Data.Directory.Management.PropertySet

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

ReadFromDomainController

Необязательный

System.Management.Automation.SwitchParameter

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

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

RecipientPreviewFilter

Необязательный

System.String

Параметр RecipientPreviewFilter указывает фильтр получателей, который будет определять получателей, возвращаемых данной командой. Можно создать настраиваемый фильтр получателей для динамической группы рассылки, список адресов или политику адресов электронной почты. Чтобы проверить, что указанный фильтр получателей возвращает необходимых получателей, можно передать фильтр OPATH, указанный в свойстве RecipientFilter для данной динамической группы рассылки, списка адресов или политики адресов электронной почты, параметру RecipientPreviewFilter и просмотреть список получателей.

RecipientType

Необязательный

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

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

  • DynamicDistributionGroup

  • UserMailbox

  • MailUser

  • MailContact

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailNonUniversalGroup

  • PublicFolder

RecipientTypeDetails

Необязательный

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

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

Ниже перечислены доступные значения.

  • ArbitrationMailbox

  • ConferenceRoomMailbox

  • Contact

  • DiscoveryMailbox

  • DynamicDistributionGroup

  • EquipmentMailbox

  • ExternalManagedContact

  • ExternalManagedDistributionGroup

  • LegacyMailbox

  • LinkedMailbox

  • MailboxPlan

  • MailContact

  • MailForestContact

  • MailNonUniversalGroup

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailUser

  • PublicFolder

  • RoleGroup

  • RoomList

  • RoomMailbox

  • SharedMailbox

  • SystemAttendantMailbox

  • SystemMailbox

  • User

  • UserMailbox

ResultSize

Необязательный

Microsoft.Exchange.Data.Unlimited

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

SortBy

Необязательный

System.String

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

  • Alias

  • DisplayName

  • Name

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

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

Для запуска этого командлета необходимы соответствующие разрешения. В этом разделе перечислены все параметры командлета, однако некоторые из них могут быть недоступны, если они не включены в назначенные разрешения. Сведения о необходимых разрешениях см. в разделе Подраздел «Разрешения подготовки получателей» в разделе Разрешения для почтового ящика.

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

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

Ошибки

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

  

 

Исключения

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

  

 

Примеры

ПРИМЕР 1

В этом примере выполняется получение сведений о всех получателях в организации.

Скопировать код
Get-Recipient -ResultSize unlimited

ПРИМЕР 2

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

Скопировать код
Get-Recipient -RecipientType MailContact -SortBy Name