Get-CsAdUser

 

上一次修改主题: 2012-03-23

返回有关 Active Directory 域服务 (AD DS) 中所有用户帐户的信息。这包括已启用 Microsoft Lync Server 2010 的用户帐户和未启用 Lync Server 2010 的帐户。

语法

Get-CsAdUser [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LDAPFilter <String>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>]

详细说明

Get-CsAdUser 返回有关 Active Directory 中所有用户帐户的信息,包括已经启用和尚未启用 Lync Server 的用户帐户。它与 Get-CsUser 不同,后者仅返回帐户已启用 Lync Server 或以前版本的软件(例如 Microsoft Office Communications Server 2007 R2)的用户的信息。

尽管 Get-CsAdUserGet-CsUser 之间有一些重叠的地方,但这两个 cmdlet 所返回的信息类型有所不同。通常,Get-CsUser 返回专门与 Lync Server 相关的 Active Directory 属性的值。例如,Get-CsUser 可以告诉您已向用户分配了哪些 Lync Server 策略,为该用户分配的线路统一资源标识符 (URI),以及用户是否已启用企业语音。除非某个用户已启用 Lync Server,否则这些属性将不属于该用户帐户。

相比之下,Get-CsAdUser 返回 Active Directory 常规属性的值;也就是说,它返回有关属于基本 Active Directory 用户帐户的属性的信息,以及表示用户是否已启用 Lync Server 的属性的信息。例如,Get-CsAdUser 返回用户的如下信息:工作部门和组织、职务、电话号码和办公地址等。要查看 Get-CsAdUser 返回的属性值的完整列表,请在 Windows PowerShell 提示符下键入此命令:

Get-CsAdUser | Get-Member

Get-CsAdUser 提供了一些方法,可用于筛选运行此 cmdlet 时返回的用户集合。例如,如果您不希望返回所有 Active Directory 用户帐户,则可以应用可选参数 Filter 或 LdapFilter。这两个参数相互排斥:如果您在某个命令中使用了 Filter,则不能在同一命令中使用 LdapFilter,反之亦然。使用 Filter 参数可以将返回的数据限制为满足 Lync Server 特定属性的指定条件的用户。例如,可以使用 Filter 参数返回已经启用或尚未启用 Lync Server 的用户的集合。使用 LdapFilter 参数可以将返回的数据限制为满足基于 Active Directory 常规属性的其他条件的用户,例如在指定州或省工作的用户,拥有或没有寻呼机的用户,或者拥有指定职务的用户。

有关 Get-CsAdUser cmdlet 的一个重要事项是,虽然用于确定用户是否已启用 Lync Server 的 Enabled 属性是一个布尔值,但该属性实际上有三个有效值:

True。用户已经启用 Lync Server

False。用户暂时禁用了其 Lync Server 帐户。这通常通过使用 Set-CsUser cmdlet 并将 Enabled 参数设置为 $False 来执行。

Null。用户未启用 Lync Server。

这意味着,如果要返回未启用 Lync Server 的用户的列表,则必须使用返回 Enabled 属性为 Null 的所有用户的命令:

Get-CsAdUser –Filter {Enabled –eq $Null}

相比之下,以下命令仅返回那些暂时禁用了 Lync Server 帐户的用户:

Get-CsAdUser –Filter {Enabled –eq $False}

运行上述命令时将不返回未启用 Lync Server 的用户。

谁能运行此 cmdlet:默认情况下,以下各组的成员有权在本地运行 Get-CsAdUser cmdlet:RTCUniversalUserAdmins、RTCUniversalServerAdmins 和 RTCUniversalReadOnlyAdmins。要返回分配了此 cmdlet 的所有基于角色的访问控制 (RBAC) 角色列表(包括您自己创建的任何自定义 RBAC 角色),请从 Windows PowerShell 提示符处运行以下命令:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsAdUser"}

参数

参数 必需 类型 描述

Identity

可选

用户 ID 参数

指示要检索的用户帐户的标识。可以采用下列四种格式之一来指定用户标识:1) 用户的 SIP 地址;2) 用户的用户主体名称 (UPN);3) 用户的域名和登录名,格式为“域名\登录名”(如 litwareinc\kenmyer);以及 4) 用户的 Active Directory 显示名称(例如 Ken Myer)。还可以使用用户的 Active Directory 可分辨名称引用用户帐户。

在使用显示名称作为用户标识时,可以使用通配符星号 (*)。例如,标识“* Smith”将返回显示名称以字符串值“Smith”结尾的所有用户。

Credential

可选

PSCredential 对象

用于通过备用凭据运行 Get-CsAdUser cmdlet。如果您登录 Windows 时所使用的帐户没有使用用户对象所需的必要权限,则可能需要使用该对象。

要使用 Credential 参数,必须首先通过 Get-Credential cmdlet 创建 PSCredential 对象。有关详细信息,请参阅 Get-Credential 帮助主题。

DomainController

可选

字符串

用于连接到指定的域控制器,以便检索用户信息。要连接到特定的域控制器,请包含 DomainController 参数,后跟完全限定域名 (FQDN)(例如 atl-cs-001.litwareinc.com)。

Filter

可选

字符串

用于通过筛选特定于 Lync Server 的属性来限制返回的数据。

Filter 参数与 Where-Object cmdlet 使用相同的 Windows PowerShell 筛选语法。例如,仅返回未启用 Lync Server 的用户的筛选器语法如下:{Enabled -ne $True},其中 Enabled 代表 Active Directory 属性,-ne 代表比较运算符(不等于),$True(内置的 Windows PowerShell 变量)代表值 True。

LdapFilter

可选

字符串

使您可以通过筛选 Active Directory 常规属性(即不是特定于 Lync Server 的属性)来限制返回的数据。例如,您可以将返回数据限制为在特定部门工作的用户,或者限制为拥有特定经理或其他职务的用户。

LdapFilter 参数在创建筛选器时使用 LDAP 查询语言。例如,仅返回在 Redmond 市工作的用户的筛选器语法如下:"l=Redmond",其中“l”(小写的 L)代表 Active Directory 属性 (locality);“=”代表比较运算符(等于);“Redmond”代表筛选器值。

OU

可选

可分辨名称

使您可以返回特定 Active Directory 组织单位 (OU) 或容器中的用户。此参数将返回来自指定 OU 及其所有子 OU 的数据。例如,如果 Finance OU 有两个子 OU,AccountsPayable 和 AccountsReceivable,则将从这三个 OU 返回用户。

指定 OU 时,请使用此容器的可分辨名称 (DN),例如:OU=Finance,dc=litwareinc,dc=com。要从“用户”容器返回用户,请使用以下语法:cn=Users,dc=litwareinc,dc=com。

ResultSize

可选

整数

用于限制 cmdlet 返回的记录数。例如,要返回七个用户(不管林中有多少用户),请包含 ResultSize 参数,并将参数值设置为 7。请注意,无法保证返回哪七个用户。

结果大小可以设置为 0 到 2147483647(包含边界值)之间的任意整数。如果设置为 0,命令将运行,但是不会返回任何数据。如果将 ResultSize 设置为 7,但是林中仅有三个用户,则此命令将返回这三个用户,操作完成,并且不生成错误。

输入类型

字符串。Get-CsAdUser 接受通过管道传递的代表 Active Directory 用户帐户 Identity 的字符串值。

返回类型

Get-CsAdUser 返回 Microsoft.Rtc.Management.ADConnect.Schema.CSADUser 对象的实例。

示例

-------------------------- 示例 1 --------------------------

Get-CsAdUser

示例 1 中显示的命令返回 Active Directory 域中所有用户帐户的集合。

-------------------------- 示例 2 --------------------------

Get-CsAdUser -Identity "Pilar Ackerman"

在示例 2 中,Get-CsAdUser 返回 Pilar Ackerman 的用户帐户信息。在此示例中,使用用户的显示名称来指定其标识。

-------------------------- 示例 3 --------------------------

Get-CsAdUser -OU "ou=Finance,dc=litwareinc,dc=com"

示例 3 返回 Finance 组织单位中所有用户的用户帐户信息。为执行此操作,必须将此 OU 的 DN 传递给 OU 参数。

-------------------------- 示例 4 --------------------------

Get-CsAdUser -Filter {Enabled -ne $True} | Select-Object DisplayName

在上述命令中,返回所有尚未启用 Lync Server 2010 或 Office Communications Server 的用户。为执行此操作,使用 Filter 参数与 Get-CsAdUser ,以将返回的数据限制为 Enabled 属性不等于 True 的用户帐户。此筛选器指示 Get-CsAdUser 仅返回尚未启用以用于 Lync Server 或 Office Communications Server 的用户帐户。检索数据后,信息将通过管道传递到 Select-Object cmdlet,然后后者会标识将实际显示在屏幕上的唯一属性(在此示例中为 DisplayName)。

-------------------------- 示例 5 --------------------------

Get-CsAdUser -LdapFilter "Department=Finance"

在示例 5 中,LdapFilter 参数用于将返回数据限制为在 Finance 部门工作的用户。这是通过使用 LDAP 筛选器值“Department=Finance”实现的。

另请参阅

其他资源

Get-CsUser