Get-EXORecipient
Этот командлет доступен только в модуле PowerShell Exchange Online. Дополнительные сведения см. в разделе Сведения о модуле PowerShell Exchange Online.
Используйте командлет Get-EXORecipient для просмотра существующих объектов получателей в организации. Этот командлет возвращает все объекты с включенной поддержкой почты (например, почтовые ящики, пользователей почты, почтовые контакты и группы рассылки).
Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.
Синтаксис
Identity (По умолчанию)
Get-EXORecipient
[[-Identity] <String>]
[-ExternalDirectoryObjectId <Guid>]
[-Filter <String>]
[-IncludeSoftDeletedRecipients]
[-OrganizationalUnit <String>]
[-PrimarySmtpAddress <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-RecipientPreviewFilter <String>]
[-RecipientType <String[]>]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[-UserPrincipalName <String>]
[<CommonParameters>]
Anr
Get-EXORecipient
[-Anr <String>]
[-Filter <String>]
[-IncludeSoftDeletedRecipients]
[-OrganizationalUnit <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-RecipientPreviewFilter <String>]
[-RecipientType <String[]>]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
Описание
Get-EXORecipient командлет можно использовать для просмотра существующих объектов получателей в организации. Этот командлет возвращает все объекты с включенной поддержкой почты (например, почтовые ящики, пользователей почты, почтовые контакты и группы рассылки).
Примеры
Пример 1
Get-EXORecipient -ResultSize 100
В этом примере возвращаются первые 100 объектов получателей в порядке сортировки имен.
Пример 2
Get-EXORecipient -Identity john@contoso.com
В этом примере возвращаются сведения об атрибуте получателя для пользователя. john@contoso.com
Параметры
-Anr
Применимо: Exchange Online
Параметр Anr определяет строку, по которой будет выполнен поиск с разрешением неоднозначных имен (ANR). Можно задать частичное строковое значение и выполнить поиск объектов с атрибутом, который совпадает с этой строкой. По умолчанию искомыми атрибутами являются:
- CommonName (CN)
- DisplayName
- FirstName
- LastName
- Alias
Этот параметр нельзя использовать с параметрами ExternalDirectoryObjectId, Identity, PrimarySmtpAddress или UserPrincipalName.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Anr
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ExternalDirectoryObjectId
Применимо: Exchange Online
Параметр ExternalDirectoryObjectId определяет получателя, который вы хотите просмотреть с помощью ObjectId в Microsoft Entra ID.
Этот параметр нельзя использовать с параметрами Anr, Identity, PrimarySmtpAddress или UserPrincipalName.
Свойства параметров
| Тип: | Guid |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-Filter
Применимо: Exchange Online
Параметр Filter использует синтаксис OPATH для фильтрации результатов по указанным свойствам и значениям. Для критериев поиска используется следующий синтаксис: "Property -ComparisonOperator 'Value'".
- Заключите весь фильтр OPATH в двойные кавычки "". Если фильтр содержит системные значения (например,
$true,$falseили$null), используйте одиночные кавычки ' '. Хотя этот параметр является строкой (а не системным блоком), вы также можете использовать фигурные скобки { }, но только если фильтр не содержит переменные. - Property — это свойство с поддержкой фильтрации. Дополнительные сведения о фильтруемых свойствах см. в разделах Наборы свойств Get-EXORecipient и Фильтруемые свойства для параметра 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.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Identity
Применимо: Exchange Online
Параметр Identity определяет объект получателя, который необходимо просмотреть. Для максимальной производительности рекомендуется использовать следующие значения для определения получателя:
- Идентификатор пользователя или имя участника-пользователя
- GUID
В противном случае можно использовать любое значение, однозначно определяющее получателя. Например:
- Имя
- Псевдоним
- различающееся имя (DN);
- Домен\Имя пользователя
- Адрес электронной почты
- LegacyExchangeDN
- SamAccountName
Этот параметр нельзя использовать с параметрами Anr, ExternalDirectoryObjectId, PrimarySmtpAddress или UserPrincipalName.
Внимание! Значение $null или несуществующее значение для параметра Identity возвращает все объекты, как если бы вы выполнили команду Get- без параметра Identity. Убедитесь, что все списки значений для параметра Identity являются точными и не содержат несуществующих $null значений.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | 0 |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-IncludeSoftDeletedRecipients
Применимо: Exchange Online
Параметр IncludeSoftDeletedRecipients указывает, следует ли включать обратимо удаленных получателей в результаты. С этим параметром не нужно указывать значение.
Обратимо удаленные получатели — это получатели, которые по-прежнему можно восстановить.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-OrganizationalUnit
Применимо: Exchange Online
Параметр OrganizationalUnit фильтрует результаты по расположению объекта в Active Directory. Возвращаются только те объекты, которые существуют в указанном расположении. Допустимые значения для этого параметра — подразделение или домен, который можно отобразить с помощью командлета Get-OrganizationalUnit. Вы можете использовать любое значение, уникальным образом определяющее подразделение или домен. Пример:
- Имя
- Имя
- различающееся имя (DN);
- GUID
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-PrimarySmtpAddress
Применимо: Exchange Online
PrimarySmtpAddress определяет получателя, которого вы хотите просмотреть по основному SMTP-адресу электронной почты (например, navin@contoso.com).
Этот параметр нельзя использовать с параметрами Anr, ExternalDirectoryObjectId, Identity или UserPrincipalName.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-Properties
Применимо: Exchange Online
Параметр Properties указывает свойства, возвращаемые в выходных данных этого командлета. Вы можете указать несколько значений, разделив их запятыми.
Дополнительные сведения о доступных свойствах см. в разделе Наборы свойств Get-EXORecipient.
Свойства параметров
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-PropertySets
Применимо: Exchange Online
Параметр PropertySets задает логическое группирование свойств, возвращаемых в выходных данных этого командлета. Допустимые значения:
- Минимум (это значение по умолчанию)
- Архив
- Пользовательский
- MailboxMove
- Политика
Дополнительные сведения о свойствах, включенных в каждый набор свойств, см. в разделе Наборы свойств Get-EXORecipient.
Свойства параметров
| Тип: | PropertySet[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RecipientPreviewFilter
Применимо: Exchange Online
Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RecipientType
Применимо: Exchange Online
Параметр RecipientType фильтрует результаты по указанному типу получателя. Допустимые значения:
- DynamicDistributionGroup
- MailContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- UserMailbox
Вы можете указать несколько значений, разделив их запятыми.
Свойства параметров
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RecipientTypeDetails
Применимо: Exchange Online
Параметр RecipientTypeDetails фильтрует результаты по указанному подтипу получателя. Допустимые значения:
- DiscoveryMailbox
- DynamicDistributionGroup
- EquipmentMailbox
- GroupMailbox
- GuestMailUser
- Устаревшая версияMailbox
- LinkedMailbox
- LinkedRoomMailbox
- MailContact
- MailForestContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- PublicFolderMailbox
- RemoteEquipmentMailbox
- RemoteRoomMailbox
- RemoteSharedMailbox
- RemoteTeamMailbox
- RemoteUserMailbox
- RoomList
- RoomMailbox
- SchedulingMailbox
- SharedMailbox
- SharedWithMailUser
- TeamMailbox
- UserMailbox
Вы можете указать несколько значений, разделив их запятыми.
Значение параметра RecipientType влияет на значения, которые можно использовать для этого параметра. Например, если вы используете значение RecipientType MailContact, вы не сможете использовать значение UserMailbox для этого параметра. Появляется сообщение об ошибке: ни один из указанных RecipientTypeDetails не включается в указанный тип получателя.
Свойства параметров
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ResultSize
Применимо: Exchange Online
Параметр ResultSize указывает максимальное число возвращаемых результатов. Если требуется возвратить все результаты, отвечающие условиям запроса, используйте для этого параметра значение unlimited. Значение по умолчанию — 1000.
Свойства параметров
| Тип: | Unlimited |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-UserPrincipalName
Применимо: Exchange Online
Параметр UserPrincipalName определяет получателя, который вы хотите просмотреть по имени участника-пользователя (например, navin@contoso.onmicrosoft.com).
Этот параметр нельзя использовать с параметрами Anr, ExternalDirectoryObjectId, Identity или PrimarySmtpAddress.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в статье about_CommonParameters.