Get-Recipient

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

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

Примечание. В Exchange Online PowerShell рекомендуется использовать Get-EXORecipient вместо этого комлета. Дополнительные сведения см. в статье Connect to Exchange Online PowerShell.

В облачных средах для возврата Microsoft 365 Groups необходимо использовать параметр RecipientTypeDetails со значением GroupMailbox.

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

Синтаксис

Get-Recipient
   [-Anr <String>]
   [-AuthenticationType <AuthenticationType>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-Capabilities <MultiValuedProperty>]
   [-Database <DatabaseIdParameter>]
   [-Properties <String[]>]
   [-IncludeSoftDeletedRecipients]
   [<CommonParameters>]
Get-Recipient
   [[-Identity] <RecipientIdParameter>]
   [-AuthenticationType <AuthenticationType>]
   [-BookmarkDisplayName <String>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-IncludeBookmarkObject <Boolean>]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-Capabilities <MultiValuedProperty>]
   [-Properties <String[]>]
   [-IncludeSoftDeletedRecipients]
   [<CommonParameters>]
Get-Recipient
   [-Database <DatabaseIdParameter>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-Properties <String[]>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-IncludeSoftDeletedRecipients] [<CommonParameters>]
   [<CommonParameters>]
Get-Recipient
   [-RecipientPreviewFilter <String>]
   [-AuthenticationType <AuthenticationType>]
   [-Capabilities <MultiValuedProperty>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-IncludeSoftDeletedRecipients]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-Properties <String[]>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [<CommonParameters>]

Описание

Командлет Get-Recipient может не возвращать все зависящие от объекта свойства для получателя. Чтобы просмотреть зависящие от объекта свойства для группы, необходимо использовать соответствующий командлет на основе типа объекта (например, Get-Mailbox, Get-MailUser или Get-DistributionGroup).

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

Примеры

Пример 1

Get-Recipient -ResultSize unlimited

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

Пример 2

Get-Recipient -Identity "Marketing Department" | Format-List

В этом примере возвращается подробная информация для получателя с именем Отдел маркетинга.

Пример 3

Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,Name

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

Параметры

-Anr

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

  • CommonName (CN)
  • DisplayName
  • FirstName
  • LastName
  • Alias
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection
-AuthenticationType

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

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

  • Federated
  • Управление
Type:AuthenticationType
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Security & Compliance Center, Exchange Online Protection
-BookmarkDisplayName

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection
-Capabilities

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

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

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Security & Compliance Center, Exchange Online Protection
-Credential

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

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

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

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-Database

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

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

  • имя;
  • различающееся имя (DN);
  • GUID
Type:DatabaseIdParameter
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-DomainController

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

Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, dc01.contoso.com.

Type:Fqdn
Position:Named
Default value:None
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 — это свойство с поддержкой фильтрации. Дополнительные сведения о свойствах, которые можно фильтровать, см. в дополнительных сведениях о фильтруемых свойствах для параметра Filter.
  • ComparisonOperator — это оператор сравнения OPath (например, -eq для равенства и -like для сравнения строк). Подробнее об операторах сравнения см. в статье about_Comparison_Operators.
  • Значение — это значение свойства, для поиска. Заключите текстовые значения и переменные в одиночные кавычки ('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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection
-Identity

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

  • Имя
  • Псевдоним
  • различающееся имя (DN);
  • различающееся имя (DN);
  • Каноническое краткое имя
  • GUID
Type:RecipientIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection
-IgnoreDefaultScope

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

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

При использовании параметра IgnoreDefaultScope действуют следующие ограничения:

  • При этом параметр DomainController использовать нельзя. Команда автоматически использует соответствующий сервер глобального каталога.
  • При этом параметр DomainController использовать нельзя. Команда автоматически использует соответствующий сервер глобального каталога.
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-IncludeBookmarkObject

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

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection
-IncludeSoftDeletedRecipients

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

Удаленные получатели — это удаленные получатели, которые еще можно восстановить.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection
-OrganizationalUnit

Параметр OrganizationalUnit фильтрует результаты в зависимости от расположения объекта в Active Directory. Возвращаются только те объекты, которые существуют в указанном расположении. Допустимые значения для этого параметра — подразделение или домен, которые возвращаются с помощью командлета Get-OrganizationalUnit. Вы можете использовать любое значение, уникальным образом определяющее подразделение или домен. Пример:

  • Имя
  • Имя
  • различающееся имя (DN);
  • GUID
Type:OrganizationalUnitIdParameter
Position:Named
Default value:None
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
-Properties

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

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection
-PropertySet

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

Type:PropertySet
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection
-ReadFromDomainController

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

Переключатель ReadFromDomainController указывает, что сведения будут считываться из контроллера домена в домене пользователя. Если выполнить команду Set-AdServerSettings -ViewEntireForest $true для включения всех объектов в лесу и переключатель ReadFromDomainController не используется, сведения могут быть считаны из глобального каталога с устаревшими данными. Если переключатель ReadFromDomainController используется, возможно, понадобится выполнить считывание несколько раз, чтобы получить сведения. Значение этого параметра указывать необязательно.

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-RecipientPreviewFilter

Параметр RecipientPreviewFilter тестирует фильтр получателей, который можно использовать в динамической группе рассылки, списке адресов или политике адресов электронной почты. Этот параметр использует синтаксис фильтра Opath (тот же "Property -ComparisonOperator 'Value'" синтаксис, что и параметр RecipientFilter).

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

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection
-RecipientType

Параметр RecipientType фильтрует результаты по указанному типу получателя. Допустимые значения:

  • DynamicDistributionGroup
  • MailContact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • UserMailbox

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

Type:RecipientType[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection
-RecipientTypeDetails

Параметр RecipientTypeDetails фильтрует результаты по указанному подтипу получателя. Допустимые значения:

  • DiscoveryMailbox
  • DynamicDistributionGroup
  • EquipmentMailbox
  • GroupMailbox
  • GuestMailUser
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox
  • MailContact
  • MailForestContact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • PublicFolderMailbox
  • RemoteEquipmentMailbox
  • RemoteRoomMailbox
  • RemoteSharedMailbox
  • RemoteTeamMailbox
  • RemoteUserMailbox
  • RoomList
  • RoomMailbox
  • SchedulingMailbox
  • SharedMailbox
  • TeamMailbox
  • UserMailbox

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

Значение параметра RecipientType влияет на значения, которые можно использовать для этого параметра. Например, если используется значение RecipientType MailContact, для этого параметра нельзя использовать значение UserMailbox. Вы получите ошибку. Ни один из указанных recipientTypeDetails не включен в указанный тип получателя.

Type:RecipientTypeDetails[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection
-ResultSize

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

Type:Unlimited
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection
-SortBy

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

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

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

  • Имя
  • DisplayName
  • Alias
  • Город
  • FirstName
  • LastName
  • Office
  • ServerLegacyDN
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection

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

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

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

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