Get-CsApplicationEndpoint
上次修改主題的時間: 2012-03-23
擷取 應用程式服務 的端點。
語法
Get-CsApplicationEndpoint [-Identity <UserIdParameter>] [-ApplicationId <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-OU <OUIdParameter>] [-PoolFqdn <String>] [-ResultSize <Unlimited>]
詳細描述
此指令程式會從 Active Directory 網域服務 (AD DS) 擷取一或多個應用程式連絡人。這些物件儲存於 Active Directory 內 RTC 服務的應用程式連絡人容器中。
誰可以執行此 Cmdlet:下列群組的成員預設會獲授權可以在本機上執行 Get-CsApplicationEndpoint Cmdlet:RTCUniversalUserAdmins、RTCUniversalServerAdmins、RTCUniversalReadOnlyAdmins。若要傳回所有獲指派此 Cmdlet 的角色存取控制 (RBAC) 角色清單 (包括您自行建立的自訂 RBAC 角色),請在 Windows PowerShell 提示字元中執行下列命令:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsApplicationEndpoint"}
參數
參數 | 必要 | 類型 | 描述 |
---|---|---|---|
Identity |
選用 |
UserIdParameter |
要擷取之應用程式端點的 Identity、SIP 位址或顯示名稱。Identity 由端點的辨別名稱組成。這通常會包含一個全域唯一識別碼 (GUID) 作為 CN 的一部分,例如:CN={8811fefe-e0bb-4fab-ae39-7aaeddd423dc},CN=Application Contacts,CN=RTC Service,CN=Services,CN=Configuration,DC=Vdomain,DC=com。 |
ApplicationId |
選用 |
字串 |
您要擷取之應用程式端點的應用程式識別碼。應用程式 ID 是端點 OwnerUrn 屬性的值。例如,如果 OwnerUrn 屬性的值為 urn:application:Caa,則應用程式 ID 為 urn:application:Caa。但是,您只能輸入尾碼 (在此例中為 Caa) 來擷取端點。例如:-ApplicationId Caa |
Credential |
選用 |
PSCredential |
將用於繼續執行 Get 作業的替代認證。您可以呼叫 Windows PowerShell 指令程式 Get-Credential 來擷取 PSCredential 物件。 |
DomainController |
選用 |
Fqdn |
容許您指定網域控制站。若未指定網域控制站,則會使用第一個可用的網域控制站。 |
Filter |
選用 |
字串 |
可讓您篩選 Microsoft Lync Server 2010 的特定屬性來限制傳回的資料。例如,您可以將傳回的資料限制在其顯示名稱或 SIP 位址符合特定萬用字元模式的連絡人。 Filter 參數使用的 Windows PowerShell 篩選語法與 Where-Object 指令程式相同。例如,只傳回已啟用 Enterprise Voice 之連絡人的篩選看起來如下所示:{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 相關聯的應用程式端點。這是藉由將 tapp2 這個 ID 傳給 ApplicationId 參數來達成。請注意,我們並未提供集區 FQDN;這表示如果其 ID 為 tapp2 的應用程式存在多個集區上,則會擷取所有這些應用程式的端點。此命令的下個部分會將傳回的物件傳送至 Select-Object 指令程式,以只顯示這些物件的 Identity、SipAddress、DisplayName 和 OwnerUrn 屬性。