Get-User

此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 一些参数和设置可能只适用于某个特定的环境。

使用 Get-User cmdlet 可查看组织中现有的用户对象。 此 cmdlet 可返回具有用户帐户的所有对象(例如,用户邮箱、邮件用户和用户帐户)。

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

语法

Get-User
   [-Anr <String>]
   [-Arbitration]
   [-AuditLog]
   [-AuxAuditLog]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-IsVIP]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PublicFolder]
   [-ReadFromDomainController]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-Sortby <String>]
   [-SupervisoryReviewPolicy]
   [<CommonParameters>]
Get-User
   [[-Identity] <UserIdParameter>]
   [-Arbitration]
   [-AuditLog]
   [-AuxAuditLog]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-IsVIP]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PublicFolder]
   [-ReadFromDomainController]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-Sortby <String>]
   [-SupervisoryReviewPolicy]
   [<CommonParameters>]

说明

Get-User cmdlet 不返回邮箱或邮件用户的任何邮件相关属性。 若要查看用户的邮件相关属性,您需要使用基于对象类型的相应 cmdlet(例如,Get-Mailbox 或 Get-MailUser)。

您必须先获得权限,然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数,但如果这些参数并未包含在分配给您的权限中,那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet

示例

示例 1

Get-User -ResultSize unlimited

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

示例 2

Get-User -Identity "Coy Damon" | Format-List

此示例返回名为 Coy Damon 的用户的详细信息。

示例 3

Get-User -OrganizationalUnit "Marketing"

第一个示例检索 Marketing OU 中用户的有关信息。

示例 4

Get-User -Filter "Title -like 'Manager*'"

第二个示例使用 Filter 参数来检索在用户职务名称末尾包含单词“Manager”的所有用户的信息。

参数

-Anr

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

  • CommonName (CN)
  • DisplayName
  • FirstName
  • LastName
  • 别名
Type:String
Position:Named
Default value:None
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

-Arbitration

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

需要仲裁开关才能在结果中返回仲裁邮箱。 不必为此开关指定值。

仲裁邮箱是用于存储不同类型的系统数据和管理邮件审批工作流的系统邮箱。

若要返回用于存储审核日志设置或数据的仲裁邮箱,请不要使用此开关。 请改用 AuditLog 或 AuxAuditLog 开关。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-AuditLog

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

需要 AuditLog 开关才能在结果中返回审核日志邮箱。 不必为此开关指定值。

审核日志邮箱是用于存储审核日志设置的仲裁邮箱。

若要返回其他类型的仲裁邮箱,请不要使用此开关。 请改用仲裁开关。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-AuxAuditLog

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

需要 AuxAuditLog 开关才能在结果中返回辅助审核日志邮箱。 不必为此开关指定值。

审核日志邮箱是用于存储审核日志设置的仲裁邮箱。

若要返回其他类型的仲裁邮箱,请不要使用此开关。 请改用仲裁开关。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-Credential

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

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

此参数的值需要 Get-Credential cmdlet。 要暂停此命令并接收凭据提示,请使用值 (Get-Credential)。 或者,在运行此命令之前,请将凭据存储在变量(例如,$cred = Get-Credential)中,然后将变量名称 ($cred) 用作此参数。 有关详细信息,请参阅 Get-Credential

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-DomainController

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

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

Type:Fqdn
Position:Named
Default value:None
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) ,请改用单引号 ' 。 虽然此参数是一个字符串 (不是) 的系统块,但也可以使用大括号 { },但前提是筛选器不包含变量。
  • 属性是可筛选的属性。 有关 Exchange server 和 Exchange Online 中的可筛选属性的详细信息,请参阅 Filterable properties for the 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 语法信息

Type:String
Position:Named
Default value:None
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 参数指定要查看的用户。 可以使用任何能够唯一标识该用户的值。 例如:

  • 名称
  • 用户主体名称 (UPN)
  • 可分辨名称 (DN)
  • 可分辨名称 (DN)
  • GUID
Type:UserIdParameter
Position:1
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-IsVIP

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

IsVIP 开关按优先级帐户筛选结果。 不必为此开关指定值。

有关优先级帐户的详细信息,请参阅 管理和监视优先级帐户

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Exchange Online Protection

-OrganizationalUnit

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

  • 名称
  • 名称
  • 可分辨名称 (DN)
  • GUID
Type:OrganizationalUnitIdParameter
Position:Named
Default value:None
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

-PublicFolder

需要 PublicFolder 开关才能在结果中返回公用文件夹邮箱。 不必为此开关指定值。

公用文件夹邮箱是专门用于存储公用文件夹的层次结构和内容的邮箱。

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

-ReadFromDomainController

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

ReadFromDomainController 开关指定从用户域中的域控制器读取的信息。 不必为此开关指定值。

命令: Set-AdServerSettings -ViewEntireForest $true 若要包含林中的所有对象,需要 ReadFromDomainController 开关。 否则,该命令可能会使用包含过时信息的全局编录。 此外,可能需要使用 ReadFromDomainController 开关运行命令的多个迭代才能获取信息。

默认情况下,收件人范围设置为托管 Exchange 服务器的域。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-RecipientTypeDetails

RecipientTypeDetails 参数按指定的用户子类型筛选结果。 有效值包含:

  • DisabledUser
  • DiscoveryMailbox
  • EquipmentMailbox
  • GuestMailUser (Exchange 2016 或更高版本和云)
  • 仅 Exchange 2013 (GroupMailbox)
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox (Exchange 2013 或更高版本和云)
  • LinkedUser
  • MailUser
  • PublicFolderMailbox (Exchange 2013 或更高版本和云)
  • RemoteEquipmentMailbox
  • RemoteRoomMailbox
  • RemoteSharedMailbox
  • RemoteTeamMailbox (Exchange 2013 或更高版本和云)
  • RemoteUserMailbox
  • RoomMailbox
  • SchedulingMailbox (Exchange 2016 或更高版本和云)
  • SharedMailbox
  • ShareWithMailUser 仅 (云)
  • TeamMailbox (Exchange 2013 或更高版本和云)
  • User
  • UserMailbox

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

Type:RecipientTypeDetails[]
Position:Named
Default value:None
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 参数指定了要返回的结果的最大数量。 若要返回所有与查询相匹配的请求,则请将此参数的值设为无限制。 默认值为 1000。

Type:Unlimited
Position:Named
Default value:None
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
  • 市/县
  • FirstName
  • LastName
  • Office
Type:String
Position:Named
Default value:None
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

-SupervisoryReviewPolicy

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

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

输入

Input types

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

输出

Output types

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