Командлет Get-Recipient используется для возврата списка объектов получателей из службы каталогов Active Directory.
Синтаксис
get-Recipient [-Identity <RecipientIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>] |
get-Recipient [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientPreviewFilter <String>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>] |
get-Recipient [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>] |
get-Recipient [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>] |
Параметры
Параметр | Обязательный | Тип | Описание | ||
---|---|---|---|---|---|
Anr |
Необязательный |
System.String |
Параметр Anr указывает строку, в которой проводится поиск разрешения неоднозначных имен (ANR). Можно задать частичное строковое значение и выполнить поиск объектов с атрибутом, который совпадает с этой строкой. Атрибуты по умолчанию, по которым выполняется поиск:
|
||
Credential |
Необязательный |
System.Management.Automation.PSCredential |
Параметр Credential указывает имя пользователя и пароль, который нужно использовать для доступа к Active Directory. Если используется параметр Credential, перед продолжением выполнения команды запрашивается пароль учетной записи. |
||
DomainController |
Необязательный |
Microsoft.Exchange.Data.Fqdn |
Чтобы указать полное доменное имя контроллера домена, который записывает эти изменения конфигурации в Active Directory, включите в команду параметр DomainController. |
||
Filter |
Необязательный |
System.String |
Используйте параметр Filter, чтобы указать один или более атрибутов, используемых для ограничения получателей, которые возвращаются по запросу. Этот параметр не должен использоваться вместе с параметром Identity или параметром Anr. Дополнительные сведения о фильтруемых свойствах см. в разделе Фильтруемые свойства для параметра -Filter. |
||
Identity |
Необязательный |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter |
Параметр Identity идентифицирует получателя. Можно использовать одно из следующих значений:
|
||
IgnoreDefaultScope |
Необязательный |
System.Management.Automation.SwitchParameter |
Параметр IgnoreDefaultScope указывает, что при выполнении команды параметр, определяющий для командной консоли Exchange область получателя по умолчанию, должен быть проигнорирован, и задает в качестве области действия весь лес. Это обеспечивает команде доступ к объектам Active Directory, которые в текущий момент не относятся к области по умолчанию. При использовании параметра IgnoreDefaultScope действуют ограничения, описанные ниже.
|
||
OrganizationalUnit |
Необязательный |
Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter |
Параметр OrganizationalUnit указывает имя подразделения или каноническое имя домена и используется для ограничения результатов. При использовании этого параметра будут получены только получатели в указанном контейнере. Например:
|
||
ReadFromDomainController |
Необязательный |
System.Management.Automation.SwitchParameter |
Параметр ReadFromDomainController указывает, что сведения о пользователе считываются с контроллера домена в домене пользователя. Если область получателей настроена так, чтобы включать всех получателей в лесу, или если этот параметр не использован, сведения о пользователе могут считываться из глобального каталога с устаревшими сведениями. При использовании этого параметра для получения сведений может понадобиться несколько операций чтения.
|
||
RecipientPreviewFilter |
Необязательный |
System.String |
Параметр RecipientPreviewFilter используется для указания фильтра получателей, который будет определять получателей, возвращаемых данной командой. Можно создать настраиваемый фильтр получателей для динамической группы рассылки, список адресов или политику адресов электронной почты. Чтобы проверить, что указанный фильтр получателей возвращает необходимых получателей, можно передать фильтр OPATH, указанный в свойстве RecipientFilter для данной динамической группы рассылки, списка адресов или политики адресов электронной почты, параметру RecipientPreviewFilter и просмотреть список получателей. |
||
RecipientType |
Необязательный |
Microsoft.Exchange.Data.Directory.Recipient.RecipientType[] |
Параметр RecipientType указывает тип возвращаемых получателей. Можно использовать один или несколько следующих типов:
|
||
RecipientTypeDetails |
Необязательный |
Microsoft.Exchange.Data.Directory.Recipient.RecipientTypeDetails[] |
Параметр RecipientTypeDetails указывает тип возвращаемых получателей. Типы получателей в Microsoft Exchange Server 2007 разделены на типы и подтипы. Каждый тип получателей содержит все общие свойства всех подтипов. Например, тип UserMailbox представляет учетную запись пользователя в Active Directory со связанным почтовым ящиком. Поскольку имеется несколько типов почтовых ящиков, каждый тип определяется параметром RecipientTypeDetails. Например, для почтового ящика конференц-зал для параметра RecipientTypeDetails установлено значение ConferenceRoomMailbox, в то время как для почтового ящика пользователя для параметра RecipientTypeDetails установлено значение UserMailbox. Для этой команды доступны следующие сведения о типе получателя:
|
||
ResultSize |
Необязательный |
Microsoft.Exchange.Data.Unlimited |
Параметр ResultSize указывает максимальное количество возвращаемых результатов. Если требуется, чтобы возвращались все получатели, соответствующие фильтру, используйте «unlimited» (без ограничений) в качестве значения этого параметра. Значение по умолчанию равно 1000. |
||
SortBy |
Необязательный |
System.String |
Параметр SortBy указывает атрибут, по которому будут отсортированы результаты. Сортировка может выполняться только по одному атрибуту за раз. Можно выполнять сортировку по следующим атрибутам:
Результаты сортируются в порядке возрастания. |
Подробное описание
Командлет Get-Recipient позволяет получить атрибуты определенного получателя. Никакие параметры не являются обязательными. Если командлет выполняется без параметров, возвращается полный список получателей для организации.
Для выполнения командлета Get-Recipient используемой учетной записи необходимо делегировать следующую роль:
- роль администратора Exchange с правами на просмотр.
Дополнительные сведения о разрешениях, делегировании ролей и правах, необходимых для администрирования Exchange Server 2007, см. в разделе Вопросы, связанные с разрешениями.
Типы входных данных
Типы возвращаемых данных
Ошибки
Ошибка | Описание |
---|---|
|
|
Исключения
Исключения | Описание |
---|---|
|
|
Пример
В первом примере показано, как получить сведения о всех получателях в организации.
Во втором примере показано, как получить сведения обо всех контактах с включенной поддержкой почты в организации и отсортировать их по имени.
Копировать код | |
---|---|
Get-Recipient -ResultSize unlimited Get-Recipient -RecipientType MailContact -SortBy Name |