Get-MailUser

模块:

Exchange PowerShell

此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 某些参数和设置可能是一个环境或另一个环境独占。

使用 Get-MailUser cmdlet 在云环境中查看邮件用户以及Microsoft 365 组的来宾用户。

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

语法

AnrSet

Get-MailUser
    [-Anr <String>]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-ReadFromDomainController]
    [-ResultSize <Unlimited>]
    [-SharedWithMailUser]
    [-SoftDeletedMailUser]
    [-SortBy <String>]
    [<CommonParameters>]

Identity

Get-MailUser
    [[-Identity] <MailUserIdParameter>]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-ReadFromDomainController]
    [-ResultSize <Unlimited>]
    [-SharedWithMailUser]
    [-SoftDeletedMailUser]
    [-SortBy <String>]
    [<CommonParameters>]

HVEAccount

Get-MailUser
    [-HVEAccount]
    [-Filter <String>]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-ResultSize <Unlimited>]
    [-SharedWithMailUser]
    [-SortBy <String>]
    [-SoftDeletedMailUser]
    [<CommonParameters>]

说明

您必须先获得权限，然后才能运行此 cmdlet。 尽管本文列出了 cmdlet 的所有参数，但如果分配给你的权限中未包含某些参数，则可能无权访问这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限，请参阅 Find the permissions required to run any Exchange cmdlet。

示例

示例 1

Get-MailUser

本示例返回组织中所有邮件用户的摘要列表。

示例 2

Get-MailUser -Identity Ed | Format-List

此示例返回名为 Ed 的邮件用户的详细信息。

参数

-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
• 别名

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

AnrSet

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Credential

适用：Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此参数只在本地 Exchange 中可用。

Credential 参数指定用于运行此命令的用户名和密码。 通常情况下，您可以在脚本中或在需要提供具有所需权限的不同凭据时使用此参数。

必须先创建并传递凭据对象，然后才能使用此参数。 该凭据对象是使用 Get-Credential cmdlet 创建的。 有关详细信息，请参阅 Get-Credential。

参数属性

类型:	PSCredential
默认值:	None
支持通配符:	False
不显示:	False

参数集

AnrSet

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

Identity

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DomainController

适用：Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此参数只在本地 Exchange 中可用。

DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如，dc01.contoso.com。

参数属性

类型:	Fqdn
默认值:	None
支持通配符:	False
不显示:	False

参数集

AnrSet

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

Identity

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-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) ，请改用单引号 ' '。 尽管此参数是字符串 (而不是系统块) ，但您也可以使用大括号 { }，但前提是筛选器不包含变量。
• 属性是可筛选的属性。 有关 Exchange 服务器和 Exchange Online 中可筛选属性的详细信息，请参阅 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"。

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

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-HVEAccount

适用：Exchange Online，用于本地邮箱的内置安全加载项

此参数仅在基于云的服务中可用。

HVEAccount 开关指定此邮件用户帐户专门用于 高容量电子邮件服务。 不必为此开关指定值。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

HVEAccount

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Identity

适用：Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、本地内置安全加载项邮箱

标识参数指定要查看的邮件用户。 可以使用任何能够唯一标识邮件用户的值。 例如：

• 名称
• 别名
• 可分辨名称 (DN)
• 可分辨名称 (DN)
• 规范 DN
• GUID

注意： Identity 参数的值$null或不存在值将返回 所有 对象，就像您在没有 Identity 参数的情况下运行 Get- 命令一样。 验证 Identity 参数的任何值列表是否准确，且不包含不存在的$null值。

参数属性

类型:	MailUserIdParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

Identity

Position:	1
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-IgnoreDefaultScope

适用：Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

此参数只在本地 Exchange 中可用。

IgnoreDefaultScope 开关指示命令忽略 Exchange PowerShell 会话的默认收件人范围设置，并使用整个林作为范围。 不必为此开关指定值。

此开关使命令能够访问当前在默认范围内不可用的 Active Directory 对象，但也会引入以下限制：

• 无法使用 DomainController 参数。 此命令自动使用相应的全局编录服务器。
• 无法使用 DomainController 参数。 此命令自动使用相应的全局编录服务器。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

AnrSet

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

Identity

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-OrganizationalUnit

适用：Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、本地内置安全加载项邮箱

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

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

参数属性

类型:	OrganizationalUnitIdParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-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 服务器的域。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

AnrSet

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

Identity

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ResultSize

适用：Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、本地内置安全加载项邮箱

ResultSize 参数指定了要返回的结果的最大数量。 若要返回所有与查询相匹配的请求，则请将此参数的值设为无限制。 默认值为 1000。

参数属性

类型:	Unlimited
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-SharedWithMailUser

适用：Exchange Online，用于本地邮箱的内置安全加载项

此参数仅在基于云的服务中可用。

{{ Fill SharedWithMailUser 说明 }}

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

AnrSet

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

Identity

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-SoftDeletedMailUser

适用：Exchange Online，用于本地邮箱的内置安全加载项

此参数仅在基于云的服务中可用。

SoftDeletedMailUser 开关指定是否在结果中包括软删除的邮件用户。 不必为此开关指定值。

软删除的邮件用户是仍可恢复的已删除邮件用户。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-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
• 别名

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持以下常用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

Input types

若要了解此 cmdlet 接受的输入类型，请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空，则表明此 cmdlet 不接受输入数据。

输出

Output types

若要了解此 cmdlet 接受的返回类型（亦称为"输出类型"），请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空，则表明此 cmdlet 不返回任何数据。