Test-CsAddressBookWebQuery
上次修改主題的時間： 2012-03-25
測試使用者利用通訊錄 Web 查詢服務，搜尋及傳回通訊錄中資訊的能力。
語法
Test-CsAddressBookWebQuery -TargetFqdn <String> [-External <SwitchParameter>] [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetSipAddress <String>] [-UserSipAddress <String>]
Test-CsAddressBookWebQuery -TargetUri <String> -UserSipAddress <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-TargetSipAddress <String>] [-WebCredential <PSCredential>]
Test-CsAddressBookWebQuery [-TargetFqdn <String>] -UserCredential <PSCredential> -UserSipAddress <String> [-External <SwitchParameter>] [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetSipAddress <String>]
詳細描述
Test-CsAddressBookWebQuery 是「綜合交易」的範例。Microsoft Lync Server 2010 中會使用綜合交易來確認使用者可以順利完成一般工作，例如登入系統、交換立即訊息，或打給位於公用交換電話網路 (PSTN) 的電話。這些測試可由系統管理員手動執行，或由 Microsoft System Center Operations Manager (舊稱為 Microsoft Operations Manager) 這類應用程式自動執行。
綜合交易通常以兩種不同的方式進行。許多系統管理員會使用 CsHealthMonitoringConfiguration 指令程式來設定其每個登錄器集區的測試使用者。這些測試使用者是已預先設定要搭配使用綜合交易的一對使用者。(通常這些使用者是測試帳戶，而不是屬於真正使用者的帳戶)。利用針對集區設定的測試使用者，系統管理員可以對集區執行綜合交易，無須指定測試中牽涉之使用者帳戶的識別身分 (並提供其認證)。
另一種方式是系統管理員會使用真正的使用者帳戶來執行綜合交易。例如，如果兩個使用者無法交換立即訊息，則系統管理員可以使用這兩個使用者帳戶 (而非一對測試帳戶) 執行綜合交易，然後嘗試診斷及解決問題。如果您決定使用實際的使用者帳戶執行綜合交易，則必須提供每位使用者的登入名稱和密碼。
Test-CsAddressBookWebQuery 指令程式為系統管理員提供一種方法，來確認使用者可以利用通訊錄 Web 查詢服務搜尋特定的連絡人。當您執行指令程式時，Test-CsAddressBookWebQuery 會先連線至 Web 票證服務進行身分驗證。如果驗證成功，指令程式隨後會連線至通訊錄 Web 查詢服務，並搜尋指定的連絡人。如果找到該連絡人，指令程式會嘗試將該資訊傳回給本機電腦。只在這些步驟全都可以完成時，測試才會標示為成功。
誰可以執行這個指令程式：若要傳回所有獲指派此 Cmdlet 的角色存取控制 (RBAC) 角色清單 (包括您自行建立的自訂 RBAC 角色)，請在 Windows PowerShell 提示字元中執行下列命令：
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Test-CsAddressBookWebQuery"}
參數
| 參數 | 必要 | 類型 | 描述 |
|---|---|---|---|
TargetFqdn |
必要 |
字串 |
要測試之通訊錄 Web 查詢服務的登錄器集區完整網域名稱 (FQDN)。例如：-TargetFqdn "atl-cs-001.litwareinc.com"。 請注意，您無法在同一個命令中同時使用 TargetUri 參數和 TargetFqdn 參數。 |
TargetSipAddress |
必要 |
SIP 位址 |
預期要讓 通訊錄 Web 查詢服務 傳回之連絡人的 SIP 位址。例如：-TargetSipAddress "sip:kenmyer@litwareinc.com"。 |
TargetUri |
必要 |
字串 |
通訊錄 Web 查詢服務的統一資源識別項 (URI)。例如：-TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion"。 請注意，您無法在同一個命令中同時使用 TargetUri 參數和 TargetFqdn 參數。 |
UserCredential |
必要 |
PSCredential 物件 |
要在測試中使用之使用者帳戶的使用者認證物件。傳送至 UserCredential 的值應該是使用 Get-Credential 指令程式所取得的物件參考。例如，此程式碼會傳回使用者 litwareinc\kenmyer 的認證物件，並將該物件儲存於變數中，該變數的名稱為 $x:$x = Get-Credential "litwareinc\kenmyer" 執行此命令時，您需要提供使用者密碼。 |
UserSipAddress |
必要 |
SIP 位址 |
要在測試中使用之使用者的 SIP 位址。如果未指定此參數，則 Test-CsAddressBookWebQuery 會針對要測試的集區，使用狀況監控組態設定來進行檢查。 |
External |
選用 |
切換參數 |
可讓您確認外部使用者是否可使用 通訊錄 Web 查詢服務。 |
RegistrarPort |
選用 |
整數 |
登錄器服務所使用的 SIP 連接埠。如果登錄器使用預設連接埠 5061，則不需要此參數。 |
WebCredential |
選用 |
PS 認證物件 |
包含用於存取位置資訊服務的使用者認證物件。此物件可透過呼叫 Get-Credential Cmdlet 並提供適當的認證來擷取。 如果指定了 TargetUri 和 UserSipAddress 參數，而且執行命令的電腦不具伺服器憑證，則此為必要參數。 |
Force |
選用 |
切換參數 |
隱藏顯示當執行命令時可能發生的任何非嚴重錯誤訊息。 |
OutVerboseVariable |
選用 |
字串 |
此參數存在時，會以指定的變數儲存執行 Cmdlet 的詳細輸出。例如，若要以名稱為 $TestOutput 的變數儲存輸出，請使用下列語法： -OutVerboseVariable TestOutput 指定變數名稱時，請勿在前面加上 $ 字元。 |
Verbose |
選用 |
切換參數 |
指令程式執行時，在畫面上的詳細活動報告。 |
輸入類型
無。Test-CsAddressBookWebQuery 不會接受管線傳送的輸入。
傳回類型
Test-CsAddressBookWebQuery 會傳回 Microsoft.Rtc.SyntheticTransactions.TaskOutput 物件的執行個體。
範例
-------------------------- 範例 1 ------------------------
Test-CsAddressBookWebQuery -TargetFqdn atl-cs-001.litwareinc.com -TargetSipAddress "sip:kenmyer@litwareinc.com"
上述範例會搜尋 SIP 位址為 sip:kenmyer@litwareinc.com 的連絡人，來測試集區 atl-cs-001.litwareinc.com 的通訊錄 Web 查詢服務。只有在已針對集區 atl-cs-001.litwareinc.com 定義測試使用者時，此命令才有作用。如果已定義，則命令將以定義給集區之第一個測試使用者的認證執行。
如果尚未定義測試使用者，則命令將會失敗。如果您未定義集區的測試使用者，則必須加上 UserSipAddress 參數，以及應用來執行命令的使用者認證。
-------------------------- 範例 2 ------------------------
$cred1 = Get-Credential "litwareinc\kenmyer"
Test-CsAddressBookWebQuery -TargetFqdn atl-cs-001.litwareinc.com -UserCredential $cred1 -UserSipAddress "sip:kenmyer@litwareinc.com" -TargetSipAddress "sip:kenmyer@litwareinc.com"
範例 2 所示的命令也會測試通訊錄 Web 查詢服務的可用性；但在此案例中，命令是以使用者 Ken Myer (litwareinc\kenmyer) 的認證執行。為達成此目的，第一個命令會使用 Get-Credential 指令程式建立一個包含使用者 Ken Myer 之名稱與密碼的 Windows PowerShell 認證物件。(因為已加上登入名稱 (litwareinc\kenmyer) 作為參數，所以 [Windows PowerShell 認證要求] 對話方塊將只會要求系統管理員輸入 Ken Myer 帳戶的密碼。)產生的認證物件會儲存於名為 $cred1 的變數中。
在第二個命令中，使用 Test-CsAddressBookWebQuery 來測試集區 atl-cs-001.litwareinc.com 的 通訊錄 Web 查詢服務。為了以使用者 Ken Myer 的使用者認證執行此命令，加上了 UserCredential 參數和參數值 $cred1。命令也會使用 TargetSipAddress，來指定指令程式應該在通訊錄搜尋其 SIP 位址為 sip:kenmyer@litwareinc.com 的連絡人。
-------------------------- 範例 3 ------------------------
Test-CsAddressBookWebQuery -TargetUri https://atl-cs-001.litwareinc.com/groupexpansion -UserSipAddress "sip:packerman@litwareinc.com" -TargetSipAddress "sip:kenmyer@litwareinc.com"
範例 3 顯示如何對 atl-cs-001.litwareinc.com 測試 通訊錄 Web 查詢服務。為達成此目的，會呼叫 Test-CsAddressBookWebQuery 並搭配下列三個參數：TargetUri (指定 通訊錄 Web 查詢服務 的 URI)、UserSipAddress (包含在此測試中使用之使用者帳戶的 Windows PowerShell SIP 位址) 和 TargetSipAddress (包含要搜尋之使用者帳戶的 SIP 位址)。