Get-Recipient

Ссылка

Модуль:: ExchangePowerShell

Применяется к:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

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

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

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

В облачных средах, чтобы вернуть Группы Microsoft 365, необходимо использовать параметр 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
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, Security & Compliance, Exchange Online Protection

-AuthenticationType

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

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

Федеративного
Управление

Type:	AuthenticationType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online, Security & Compliance, Exchange Online Protection

-BookmarkDisplayName

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

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, Security & Compliance, Exchange Online Protection

-Capabilities

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

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

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

-Credential

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

Параметр 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

-Database

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

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

имя;
различающееся имя (DN);
GUID

Type:	DatabaseIdParameter
Position:	Named
Default value:	None
Required:	False
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
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, Security & Compliance, Exchange Online Protection

-Identity

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

Имя
Псевдоним
различающееся имя (DN);
различающееся имя (DN);
Каноническое краткое имя
GUID

Type:	RecipientIdParameter
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, Security & Compliance, Exchange Online Protection

-IgnoreDefaultScope

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

Параметр 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

-IncludeBookmarkObject

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

Type:	Boolean
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, Security & Compliance, Exchange Online Protection

-IncludeSoftDeletedRecipients

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

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

Примечание. Используйте этот параметр с параметрами Identity или RecipientTypeDetails, чтобы получить SoftDeletedRecipients.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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
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, Exchange Online Protection

-Properties

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

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

-PropertySet

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

Type:	PropertySet
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, Security & Compliance, Exchange Online Protection

-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

-RecipientPreviewFilter

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

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, Security & Compliance, Exchange Online Protection

-RecipientType

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

DynamicDistributionGroup
MailContact
MailNonUniversalGroup
MailUniversalDistributionGroup
MailUniversalSecurityGroup
MailUser
PublicFolder
UserMailbox

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

Type:	RecipientType[]
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, Security & Compliance, Exchange Online Protection

-RecipientTypeDetails

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

DiscoveryMailbox
DynamicDistributionGroup
EquipmentMailbox
GroupMailbox (Exchange 2013 или более поздней версии и облако)
GuestMailUser (Exchange 2016 или более поздней версии и облако)
Устаревшая версияMailbox
LinkedMailbox
LinkedRoomMailbox (Exchange 2013 или более поздней версии и облако)
MailContact
MailForestContact
MailNonUniversalGroup
MailUniversalDistributionGroup
MailUniversalSecurityGroup
MailUser
PublicFolder
PublicFolderMailbox (Exchange 2013 или более поздней версии и облако)
RemoteEquipmentMailbox
RemoteRoomMailbox
RemoteSharedMailbox
RemoteTeamMailbox (Exchange 2013 или более поздней версии и облако)
RemoteUserMailbox
RoomList
RoomMailbox
SchedulingMailbox (Exchange 2016 или более поздней версии и облако)
SharedMailbox
SharedWithMailUser (только для облака)
TeamMailbox (Exchange 2013 или более поздней версии и облако)
UserMailbox

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

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

Type:	RecipientTypeDetails[]
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, Security & Compliance, Exchange Online Protection

-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, Security & Compliance, Exchange Online Protection

-SortBy

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

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

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

Имя
DisplayName
Alias (Псевдоним)
Город
FirstName
LastName
Office
ServerLegacyDN

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, Security & Compliance, Exchange Online Protection

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

Input types

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

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

Output types

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

Поделиться через

Get-Recipient

Синтаксис

Описание

Примеры

Пример 1

Пример 2

Пример 3

Параметры

-Anr

-AuthenticationType

-BookmarkDisplayName

-Capabilities

-Credential

-Database

-DomainController

-Filter

-Identity

-IgnoreDefaultScope

-IncludeBookmarkObject

-IncludeSoftDeletedRecipients

-OrganizationalUnit

-Properties

-PropertySet

-ReadFromDomainController

-RecipientPreviewFilter

-RecipientType

-RecipientTypeDetails

-ResultSize

-SortBy

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

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

Обратная связь

Дополнительные ресурсы