Get-CsApplicationEndpoint
上一次修改主题: 2012-03-23
检索应用程序服务的终结点。
语法
Get-CsApplicationEndpoint [-Identity <UserIdParameter>] [-ApplicationId <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-OU <OUIdParameter>] [-PoolFqdn <String>] [-ResultSize <Unlimited>]
详细说明
此 cmdlet 从 Active Directory 域服务 (AD DS) 中检索一个或多个应用程序联系人。这些对象存储在 RTC 服务的应用程序联系人容器的 Active Directory 中。
谁能运行此 cmdlet:默认情况下,以下各组的成员有权在本地运行 Get-CsApplicationEndpoint cmdlet:RTCUniversalUserAdmins、RTCUniversalServerAdmins 和 RTCUniversalReadOnlyAdmins。要返回分配了此 cmdlet 的所有基于角色的访问控制 (RBAC) 角色列表(包括您自己创建的任何自定义 RBAC 角色),请从 Windows PowerShell 提示符处运行以下命令:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsApplicationEndpoint"}
参数
参数 | 必需 | 类型 | 描述 |
---|---|---|---|
Identity |
可选 |
UserIdParameter |
要检索的应用程序终结点的标识、SIP 地址或显示名称。标识包含终结点的可分辨名称。通常情况下,其中包含属于 CN 一部分的全局唯一标识符 (GUID),例如:CN={8811fefe-e0bb-4fab-ae39-7aaeddd423dc},CN=Application Contacts,CN=RTC Service,CN=Services,CN=Configuration,DC=Vdomain,DC=com。 |
ApplicationId |
可选 |
字符串 |
要检索的应用程序终结点的应用程序 ID。应用程序 ID 为终结点的 OwnerUrn 属性的值。例如,如果 OwnerUrn 属性的值为 urn:application:Caa,则应用程序 ID 为 urn:application:Caa。但是,只需输入后缀(在此示例中为 Caa),即可检索该终结点。例如:-ApplicationId Caa |
Credential |
可选 |
PSCredential |
继续执行 Get 操作所使用的备用凭据。可以通过调用 Windows PowerShell cmdlet Get-Credential 检索 PSCredential 对象。 |
DomainController |
可选 |
Fqdn |
用于指定域控制器。如果未指定域控制器,将使用第一个可用的域控制器。 |
Filter |
可选 |
字符串 |
用于通过筛选 Microsoft Lync Server 2010 的特定属性来限制返回的数据。例如,您可以将返回的数据限制为显示名称或 SIP 地址与某种通配符模式匹配的联系人。 Filter 参数与 Where-Object cmdlet 使用相同的 Windows PowerShell 筛选语法。例如,仅返回已启用企业语音的联系人的筛选器语法如下:{EnterpriseVoiceEnabled -eq $True},其中 EnterpriseVoiceEnabled 代表 Active Directory 属性,-eq 代表比较运算符(等于),$True(内置的 Windows PowerShell 变量)代表筛选器值。 |
OU |
可选 |
OUIdParameter |
终结点所在的组织单位 (OU)。 |
PoolFqdn |
可选 |
字符串 |
应用程序终结点所在的池的完全限定域名 (FQDN)。 |
ResultSize |
可选 |
无限制 |
要检索的终结点记录的最大数量。 |
输入类型
字符串。接受通过管道传递的代表应用程序终结点 Identity 的字符串值。
返回类型
检索一个类型为 Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact 的对象。
示例
-------------------------- 示例 1 --------------------------
Get-CsApplicationEndpoint
此示例检索有关 Lync Server 2010 部署中定义的所有应用程序终结点的信息。
-------------------------- 示例 2 --------------------------
Get-CsApplicationEndpoint -Identity "Call Park Service Contact"
示例 2 检索有关显示名称为“Call Park Service Contact”的应用程序终结点联系人的信息。
-------------------------- 示例 3 --------------------------
Get-CsApplicationEndpoint -Filter {DisplayName -like "*endpoint*"}
示例 3 检索显示名称中任意位置出现字符串“endpoint”的所有应用程序终结点。为此,该命令使用了 Filter 参数。该参数的值通过筛选找到显示名称 (DisplayName) 包含 (-like) 字符串终结点的终结点对象(*endpoint* - 该通配符指示在字符串终结点前后可以出现任意字符,即终结点可以位于显示名称中的任意位置)。
-------------------------- 示例 4 --------------------------
Get-CsApplicationEndpoint -ApplicationId tapp2 | Select-Object Identity, SipAddress, DisplayName, OwnerUrn
示例 4 将返回与应用程序 urn:application:tapp2 关联的所有应用程序终结点。这是通过将 ID tapp2 传递给 ApplicationId 参数实现的。请注意,我们未提供 FQDN 池;这意味着如果在多个池中存在 ID 为 tapp2 的应用程序,则将检索所有这些应用程序的终结点。此命令的下一部分将返回的对象通过管道传递到 Select-Object cmdlet,该 cmdlet 仅显示这些对象的 Identity、SipAddress、DisplayName 和 OwnerUrn 属性。