Get-EXORecipient

参考

模块:: ExchangePowerShell

适用于:: Exchange Online

此 cmdlet 仅在 Exchange Online PowerShell 模块中可用。有关详细信息，请参阅关于 Exchange Online PowerShell 模块。

使用 Get-EXORecipient cmdlet 查看组织中的现有收件人对象。此 cmdlet 返回所有已启用邮件的对象（例如，邮箱、邮件用户、邮件联系人和通讯组）。

有关以下语法部分的参数设置的详细信息，请参阅 Exchange cmdlet 语法。

语法

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

Get-EXORecipient
   [-Anr <String>]
   [-Filter <String>]
   [-IncludeSoftDeletedRecipients]
   [-OrganizationalUnit <String>]
   [-Properties <String[]>]
   [-PropertySets <PropertySet[]>]
   [-RecipientPreviewFilter <String>]
   [-RecipientType <String[]>]
   [-RecipientTypeDetails <String[]>]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

说明

Get-EXORecipient cmdlet 可用于查看组织中的现有收件人对象。此 cmdlet 返回所有已启用邮件的对象（例如，邮箱、邮件用户、邮件联系人和通讯组）。

示例

示例 1

Get-EXORecipient -ResultSize 100

此示例按名称排序顺序返回前 100 个收件人对象。

示例 2

Get-EXORecipient -Identity john@contosot.com

此示例返回用户的收件人属性详细信息 john@contoso.com

参数

-Anr

Anr 参数指定字符串，用于执行模糊名称解析 (ANR) 搜索。可以指定部分字符串，并搜索其属性与该字符串匹配的对象。搜索的默认属性是：

CommonName (CN)
DisplayName
FirstName
LastName
别名

不能将此参数与 ExternalDirectoryObjectId、Identity、PrimarySmtpAddress 或 UserPrincipalName 参数一起使用。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False
适用于:	Exchange Online

-ExternalDirectoryObjectId

ExternalDirectoryObjectId 参数标识要通过 Microsoft Entra ID 中的 ObjectId 查看的收件人。

不能将此参数与 Anr、Identity、PrimarySmtpAddress 或 UserPrincipalName 参数一起使用。

类型:	Guid
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False
适用于:	Exchange Online

-Filter

Filter 参数使用 OPATH 语法按指定的属性和值筛选结果。搜索条件使用语法 "Property -ComparisonOperator 'Value'"。

将整个 OPATH 筛选器括在双引号“”中。如果筛选器包含系统值 (，例如 $true、 $false或 $null) ，请改用单引号 ' 。虽然此参数是 (不是系统块) 的字符串，但也可以使用大括号 { }，但前提是筛选器不包含变量。
属性是可筛选的属性。有关可筛选属性的详细信息，请参阅 Get-EXORecipient 属性集和 Filterable 属性的 Filter 参数。
ComparisonOperator 是一个 OPATH 比较运算符， (例如 -eq 用于等于和 -like 字符串比较) 。有关比较运算符的详细信息，请参阅 about_Comparison_Operators。
Value 是要搜索的属性值。将文本值和变量括在单引号 ('Value' 或 '$Variable') 。如果变量值包含单引号，则需要识别 (转义) 单引号才能正确展开变量。例如，使用 '$($User -Replace "'","''")'而不是 '$User'。不要将整数或系统值括在引号 (例如，改用 500、 $true、 $false或 $null) 。

可以使用逻辑运算符 -and 和 -or将多个搜索条件链接在一起。例如，"Criteria1 -and Criteria2" 或 "(Criteria1 -and Criteria2) -or Criteria3"。

有关 Exchange 中的 OPATH 筛选器的详细信息，请参阅其他 OPATH 语法信息。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False
适用于:	Exchange Online

-Identity

Identity 参数指定要查看的收件人对象。为了获得最佳性能，我们建议使用以下值来标识收件人：

用户 ID 或用户主体名称 (UPN)
GUID

否则，可以使用唯一标识收件人的任何值。例如：

名称
别名
可分辨名称 (DN)
域\用户名
电子邮件地址
LegacyExchangeDN
SamAccountName

不能将此参数与 Anr、ExternalDirectoryObjectId、PrimarySmtpAddress 或 UserPrincipalName 参数一起使用。

类型:	String
Position:	0
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False
适用于:	Exchange Online

-IncludeSoftDeletedRecipients

IncludeSoftDeletedRecipients 开关指定是否在结果中包含软删除的收件人。不必为此开关指定值。

软删除的收件人是仍可恢复的已删除收件人。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False
适用于:	Exchange Online

-OrganizationalUnit

OrganizationUnit 参数根据对象在 Active Directory 中的位置筛选结果。只返回存在于指定位置的对象。此参数的有效输入是使用 Get-OrganizationalUnit cmdlet 可见的组织单位 (OU) 或域。可以使用任何能够唯一标识此 OU 或域的值。例如：

名称
名称
可分辨名称 (DN)
GUID

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False
适用于:	Exchange Online

-PrimarySmtpAddress

PrimarySmtpAddress 按主 SMTP 电子邮件地址 (标识要查看的收件人， navin@contoso.com 例如，) 。

不能将此参数与 Anr、ExternalDirectoryObjectId、Identity 或 UserPrincipalName 参数一起使用。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False
适用于:	Exchange Online

-Properties

Properties 参数指定在此 cmdlet 的输出中返回的属性。可以指定用逗号分隔的多个值。

有关可用属性的详细信息，请参阅 Get-EXORecipient 属性集。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False
适用于:	Exchange Online

-PropertySets

PropertySets 参数指定在此 cmdlet 的输出中返回的属性的逻辑分组。有效值包含:

最小 (这是默认值)
存档
自定义警报
MailboxMove
Policy

有关每个属性集中包含的属性的详细信息，请参阅 Get-EXORecipient 属性集。

类型:	PropertySet[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False
适用于:	Exchange Online

-RecipientPreviewFilter

保留此参数以供 Microsoft 内部使用。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False
适用于:	Exchange Online

-RecipientType

RecipientType 参数按指定的收件人类型筛选结果。有效值包含:

DynamicDistributionGroup
MailContact
MailNonUniversalGroup
MailUniversalDistributionGroup
MailUniversalSecurityGroup
MailUser
PublicFolder
UserMailbox

可以指定用逗号分隔的多个值。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False
适用于:	Exchange Online

-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
SharedWithMailUser
TeamMailbox
UserMailbox