Get-Recipient

Синтаксис

AnrSet

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[]>]
    [-IncludeManagerWithDisplayName]
    [-IncludeSoftDeletedRecipients]
    [<CommonParameters>]

Identity

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[]>]
    [-IncludeManagerWithDisplayName]
    [-IncludeSoftDeletedRecipients]
    [<CommonParameters>]

DatabaseSet

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>]

RecipientPreviewFilterSet

Get-Recipient
    [-RecipientPreviewFilter <String>]
    [-AuthenticationType <AuthenticationType>]
    [-Capabilities <MultiValuedProperty>]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-IncludeManagerWithDisplayName]
    [-IncludeSoftDeletedRecipients]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-Properties <String[]>]
    [-PropertySet <PropertySet>]
    [-ReadFromDomainController]
    [-RecipientType <RecipientType[]>]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [<CommonParameters>]

Описание

Примеры

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

Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, Безопасность & соответствие требованиям, встроенные средства безопасности Надстройка для локальных почтовых ящиков

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

• CommonName (CN)
• DisplayName
• FirstName
• LastName
• Alias

Свойства параметров

Наборы параметров

-AuthenticationType

Применимо: Exchange Online, безопасность & соответствие требованиям, встроенная надстройка безопасности для локальных почтовых ящиков

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

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

• Федерация
• Управление

Свойства параметров

Наборы параметров

-BookmarkDisplayName

Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, Безопасность & соответствие требованиям, встроенные средства безопасности Надстройка для локальных почтовых ящиков

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

Свойства параметров

Наборы параметров

-Capabilities

Применимо: Exchange Online, безопасность & соответствие требованиям, встроенная надстройка безопасности для локальных почтовых ящиков

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

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

Свойства параметров

Наборы параметров

-Credential

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

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

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

Свойства параметров

Наборы параметров

-Database

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

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

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

Свойства параметров

Наборы параметров

-DomainController

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

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

Свойства параметров

Наборы параметров

-Filter

Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, Безопасность & соответствие требованиям, встроенные средства безопасности Надстройка для локальных почтовых ящиков

Параметр Filter использует синтаксис OPATH для фильтрации результатов по указанным свойствам и значениям. Для критериев поиска используется следующий синтаксис: "Property -ComparisonOperator 'Value'".

• Заключите весь фильтр OPATH в двойные кавычки " ". Если фильтр содержит системные значения (например, $true, $false или $null), используйте одиночные кавычки ' '. Хотя этот параметр является строкой (а не системным блоком), вы также можете использовать фигурные скобки { }, но только если фильтр не содержит переменные.
• Property — это свойство с поддержкой фильтрации. Дополнительные сведения о фильтруемых свойствах в Exchange Server и Exchange Online см. в разделе "Фильтруемые свойства" для параметра "Фильтр".
• 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".

Свойства параметров

Наборы параметров

-Identity

Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, Безопасность & соответствие требованиям, встроенные средства безопасности Надстройка для локальных почтовых ящиков

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

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

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

Свойства параметров

Наборы параметров

-IgnoreDefaultScope

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

Ключ IgnoreDefaultScope указывает команде игнорировать параметр области получателей по умолчанию для сеанса Exchange PowerShell и использовать весь лес в качестве области. С этим параметром не нужно указывать значение.

Этот переключатель позволяет команде получать доступ к объектам Active Directory, которые в настоящее время недоступны в области по умолчанию, но также вводит следующие ограничения:

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

Свойства параметров

Наборы параметров

-IncludeBookmarkObject

Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, Безопасность & соответствие требованиям, встроенные средства безопасности Надстройка для локальных почтовых ящиков

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

Свойства параметров

Наборы параметров

-IncludeManagerWithDisplayName

Применимо: Exchange Online, встроенная надстройка безопасности для локальных почтовых ящиков

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

{{ Fill IncludeManagerWithDisplayName Description }}

Свойства параметров

Наборы параметров

-IncludeSoftDeletedRecipients

Применимо: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, встроенная надстройка безопасности для локальных почтовых ящиков

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

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

Примечание. Используйте этот переключатель с параметрами Identity или RecipientTypeDetails для получения SoftDeletedRecipients.

Свойства параметров

Наборы параметров

-OrganizationalUnit

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, встроенная надстройка безопасности для локальной среды почтовые ящики

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

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

Свойства параметров

Наборы параметров

-Properties

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, встроенная надстройка безопасности для локальных почтовых ящиков

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

Свойства параметров

Наборы параметров

-PropertySet

Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, Безопасность & соответствие требованиям, встроенные средства безопасности Надстройка для локальных почтовых ящиков

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

Свойства параметров

Наборы параметров

-ReadFromDomainController

Применимо: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

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

Команда: чтобы включить все объекты в лесу, Set-AdServerSettings -ViewEntireForest $true требуется ключ ReadFromDomainController. В противном случае команда может использовать глобальный каталог, содержащий устаревшие сведения. Кроме того, для получения информации может потребоваться выполнить несколько итераций команды с помощью переключателя ReadFromDomainController.

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

Свойства параметров

Наборы параметров

-RecipientPreviewFilter

Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, Безопасность & соответствие требованиям, встроенные средства безопасности Надстройка для локальных почтовых ящиков

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

Свойства параметров

Наборы параметров

-RecipientType

Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, Безопасность & соответствие требованиям, встроенные средства безопасности Надстройка для локальных почтовых ящиков

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

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

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

Свойства параметров

Наборы параметров

-RecipientTypeDetails

Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, Безопасность & соответствие требованиям, встроенные средства безопасности Надстройка для локальных почтовых ящиков

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

• DiscoveryMailbox
• DynamicDistributionGroup
• ОборудованиеПочтовый ящик
• GroupMailbox (Exchange 2013 или более поздней версии и облако)
• GuestMailUser (Exchange 2016 или более поздней версии и облако)
• LegacyMailbox
• 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 не включается ни в один из указанных типов получателей".

Свойства параметров

Наборы параметров

-ResultSize

Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, Безопасность & соответствие требованиям, встроенные средства безопасности Надстройка для локальных почтовых ящиков

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

Свойства параметров

Наборы параметров

-SortBy

Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, Безопасность & соответствие требованиям, встроенные средства безопасности Надстройка для локальных почтовых ящиков

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

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

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

• Имя
• DisplayName
• Alias
• Город
• FirstName
• LastName
• Office
• ServerLegacyDN

Свойства параметров

Наборы параметров

CommonParameters

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

Input types

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

Output types