Get-CsExUmContact

 

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

检索一个或多个托管 Exchange 统一消息 (UM) 联系人对象。

语法

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

详细说明

Microsoft Lync Server 2010 与 Exchange UM 结合使用以提供一些与语音相关的功能,包括自动助理和订阅者访问。以托管服务(而不是内部部署)的形式提供 Exchange UM 时,必须使用 Windows PowerShell 创建联系人对象以便应用自动助理和订阅者访问功能。此 cmdlet 可检索这些联系人中的一个或多个。

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

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

参数

参数 必需 类型 描述

Identity

可选

用户 Id 参数

要检索的联系人对象的唯一标识符。可以采用下列四种格式之一来指定联系人标识:1) 联系人的 SIP 地址;2) 联系人的用户主体名称 (UPN);3) 联系人的域名和登录名,格式为“域\登录名”(例如 litwareinc\exum1);以及 4) 联系人的 Active Directory 显示名称(例如 Team Auto Attendant)。

完整数据类型:Microsoft.Rtc.Management.AD.UserIdParameter

Filter

可选

字符串

使您可以通过筛选特定于 Lync Server 2010 的属性来限制返回的数据。例如,可以将返回的数据限制为线路 URI 以“tel:555”开头的联系人。

Filter 参数使用 Where-Object cmdlet 所用的 Windows PowerShell 筛选语法的子集。例如,仅返回已启用企业语音的联系人的筛选器语法如下:{EnterpriseVoiceEnabled -eq $True},其中 EnterpriseVoiceEnabled 代表 Active Directory 属性;-eq 代表比较运算符(等于);$True(内置的 Windows PowerShell 变量)代表筛选器值。

LdapFilter

可选

字符串

使您可以通过筛选 Active Directory 的“常规”属性(即不是特定于 Lync Server 的属性)来限制返回的数据。

LdapFilter 参数在创建筛选器时使用 LDAP 查询语言。

Credential

可选

PS 凭据

使您可以通过备用凭据运行此 cmdlet;如果您登录 Windows 时所使用的帐户没有使用联系人对象所需的必要权限,则可能需要使用该参数。

要使用 Credential 参数,必须首先通过调用 Get-Credential cmdlet 创建 PSCredential 对象。

DomainController

可选

Fqdn

使您可以连接到指定的域控制器,以便检索联系人信息。要连接到特定的域控制器,请包含 DomainController 参数,后跟计算机名称(例如 atl-mcs-001)或其完全限定域名(例如 atl-mcs-001.litwareinc.com)。

完整数据类型:Microsoft.Rtc.Management.Deploy.Fqdn

OU

可选

OUId 参数

使您可以限制仅返回从特定 Active Directory 组织单位 (OU) 检索到的信息。请注意,这将从指定 OU 及所有子 OU 返回数据。

指定 OU 时,请使用此容器的可分辨名称,例如,OU=ExUmContacts,dc=litwareinc,dc=com。

ResultSize

可选

整数

使您可以限制命令返回的记录数。例如,要返回七个联系人(不管林中有多少联系人),只需包含 ResultSize 参数,并将参数值设置为 7。请注意,无法保证返回哪七个联系人。如果将 ResultSize 设置为 7,但是林中仅有三个联系人,则此命令将返回这三个联系人,操作完成,并且不生成错误。

可以将结果大小设置为 0 到 2147483647(包含边界值)之间的任意整数。如果设置为 0,命令将运行,但是不会返回任何数据。

完整数据类型:Microsoft.Rtc.Management.ADConnect.Core.Unlimited

输入类型

字符串。接受通过管道传递的字符串值,代表 Exchange UM 联系人对象的标识。

返回类型

返回一个类型为 Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact 的对象。

示例

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

Get-CsExUmContact

此示例检索某个 Lync Server 2010 部署中定义的所有 Exchange UM 联系人。

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

Get-CsExUmContact -Identity sip:exum1@fabrikam.com

此示例检索 SIP 地址为 sip:exum1@fabrikam.com 的 Exchange UM 联系人

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

Get-CsExUmContact -Filter {Enabled -eq $False}

在此示例中,我们使用 Filter 参数来检索所有未启用 Lync Server 2010 的 Exchange UM 联系人。通过以下方式完成上述操作:筛选 Enabled 属性以查看此属性的值是否等于 (-eq) False ($False)。此命令返回的联系人将不起作用。

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

Get-CsExUmContact -Filter {LineURI -like "tel:555*"}

此命令筛选 LineURI 属性以检索 LineURI 以 555 开头的所有 Exchange UM 联系人。换句话说,此命令检索电话号码以 555 开头的所有联系人。

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

Get-CsExUmContact -OU "OU=ExUmContacts,DC=Vdomain,DC=com"

此示例中的命令使用 OU 参数检索 Active Directory OU OU=ExUmContacts,DC=Vdomain,DC=com 中的所有 Exchange UM 联系人。