你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Get-MsolUser

从 Azure Active Directory 获取用户。

语法

Get-MsolUser
   [-ReturnDeletedUsers]
   [-City <String>]
   [-Country <String>]
   [-Department <String>]
   [-DomainName <String>]
   [-EnabledFilter <UserEnabledFilter>]
   [-State <String>]
   [-Synchronized]
   [-Title <String>]
   [-HasErrorsOnly]
   [-LicenseReconciliationNeededOnly]
   [-UnlicensedUsersOnly]
   [-UsageLocation <String>]
   [-SearchString <String>]
   [-MaxResults <Int32>]
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolUser
   -ObjectId <Guid>
   [-ReturnDeletedUsers]
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolUser
   [-ReturnDeletedUsers]
   -UserPrincipalName <String>
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolUser
   [-ReturnDeletedUsers]
   [-City <String>]
   [-Country <String>]
   [-Department <String>]
   [-DomainName <String>]
   [-EnabledFilter <UserEnabledFilter>]
   [-State <String>]
   [-Synchronized]
   [-Title <String>]
   [-HasErrorsOnly]
   [-LicenseReconciliationNeededOnly]
   [-UnlicensedUsersOnly]
   [-UsageLocation <String>]
   [-SearchString <String>]
   [-All]
   [-TenantId <Guid>]
   [<CommonParameters>]

说明

Get-MsolUser cmdlet 获取单个用户或用户列表。 指定 ObjectIdUserPrincipalName 参数以获取特定用户。

示例

示例 1:获取所有用户

PS C:\> Get-MsolUser

此命令检索公司中的所有用户。 它最多显示默认值 500 个结果。

示例 2:获取已启用的用户

PS C:\> Get-MsolUser -EnabledFilter EnabledOnly -MaxResults 2000

此命令最多可获取 2000 个已启用的用户。

示例 3:通过 UPN 获取用户

PS C:\> Get-MsolUser -UserPrincipalName "davidchew@contoso.com"

此命令使用 UPN davidchew@contoso.com检索用户。

示例 4:按对象 ID 获取用户

PS C:\> Get-MsolUser -ObjectId 81701046-cb37-439b-90ce-2afd9630af7d

此命令检索具有指定对象 ID 的用户。

示例 5:通过搜索字符串获取用户

PS C:\> Get-MsolUser -SearchString "David"

此命令检索显示名称或电子邮件地址中具有 David 的用户列表。

示例 6:获取用户的首选数据位置

PS C:\> Get-MsolUser -UserPrincipalName "davidchew@contoso.onmicrosoft.com" | Select PreferredDataLocation

此命令返回用户的首选数据位置。

参数

-All

指示此 cmdlet 返回所有结果。 不要与 MaxResults 参数一起指定。

类型:SwitchParameter
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-City

指定要筛选结果的城市。

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

-Country

指定要筛选结果的国家或地区。

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

-Department

指定要筛选结果的部门。

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

-DomainName

指定要筛选结果的域。 这必须是公司的已验证域。 将返回此域上具有主要或辅助电子邮件地址的所有用户。

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

-EnabledFilter

指定启用或禁用用户的筛选器。 有效值为 All、EnabledOnly 和 DisabledOnly。

类型:UserEnabledFilter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-HasErrorsOnly

指示此 cmdlet 仅返回有验证错误的用户。

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

-LicenseReconciliationNeededOnly

指示此 cmdlet 筛选器仅适用于需要许可证对帐的用户。

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

-MaxResults

指定此 cmdlet 返回的最大结果数。 默认值为 500。

类型:Int32
Position:Named
默认值:500
必需:False
接受管道输入:False
接受通配符:False

-ObjectId

指定要获取的用户的唯一对象 ID。

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

-ReturnDeletedUsers

指示此 cmdlet 仅返回回收箱中的用户。

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

-SearchString

指定一个字符串,以匹配以此字符串开头的电子邮件地址或显示名称。

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

-State

指定用户状态的筛选器。

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

-Synchronized

指示此 cmdlet 仅返回通过 Azure Active Directory 同步同步的用户。

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

-TenantId

指定要对其执行操作的租户的唯一 ID。 默认值为当前用户的租户。 此参数仅适用于合作伙伴用户。

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

-Title

为用户的标题指定筛选器。

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

-UnlicensedUsersOnly

指示此 cmdlet 仅返回未分配许可证的用户。

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

-UsageLocation

指定用户在其中使用服务的国家或地区的筛选器。 指定一个双字母国家或地区代码。

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

-UserPrincipalName

指示要检索的用户的用户 ID。

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

输出

Microsoft.Online.Administration.User

此 cmdlet 返回用户对象,其中包括以下信息:

  • AlternateEmailAddresses。 Azure Active Directory) 外部 (用户的备用电子邮件地址。

  • BlockCredential。 用户是否能够登录。

  • 市县: 用户所在的城市。

  • 国家或地区。 用户的国家或地区。

  • 部门。 用户所在的部门。

  • DisplayName。 用户的显示名称。

  • “错误”。 一系列错误。 这是一些可能会导致服务丢失的验证错误。

  • 传真。 用户的传真号码。

  • FirstName。 用户的名字。

  • ImmutableID。 只针对联合用户返回此信息。 这是与 Azure Active Directory 联合所需的 ID。

  • isBlackBerryUser。 返回用户是否在使用 BlackBerry 设备。

  • isLicensed。 是否已向用户分配任何许可证。

  • LastDirSyncTime。 上次目录同步的日期和时间 (仅从与 Azure Active Directory 同步的用户通过 Active Directory 同步) 返回。

  • LastPasswordChangeTimestamp。 在 Azure Active Directory 中注册用户密码更改的最近时间。

  • LastName 用户的姓氏。

  • LicenseReconciliationNeeded。 用户当前是否在使用不带许可证的邮箱。 在此情况下,应该为用户提供 30 天的许可,以避免其邮箱丢失。

  • 许可证。 用户许可证列表。

  • LiveID。 用户的唯一登录 ID。

  • 手机。 用户的手机号码。

  • ObjectId。 用户的唯一 ID。

  • 办公室。 用户的办公电话号码。

  • OverallProvisioningStatus。 是否为用户设置了其服务。

  • PasswordNeverExpires。 是否应强制每隔 90 天更改用户密码一次。

  • PhoneNumber。 用户的电话号码。

  • PostalCode。 用户的邮政编码。

  • PreferredDataLocation。 用户的首选数据位置。

  • PreferredLanguage。 用户的首选语言。

  • ProxyAddresses。 与此用户关联的代理地址。

  • State。 用户所在的省/市/自治区。

  • StreetAddress。 用户的街道地址。

  • StrongPasswordRequired。 是否要求用户在更改密码时设置强密码。 建议设置强密码。

  • 标题。 用户的职务。

  • UsageLocation。 用户在其中使用服务的国家或地区。 这必须是两个字母的国家或地区代码。

  • UserPrincipalName。 用户的用户 ID。

  • ValidationStatus。 用户是否出现错误。