Get-CsAdContact
トピックの最終更新日: 2012-03-23
複数フォレスト トポロジにおいて、自身のホーム フォレスト以外のフォレストのユーザー アカウントに関する情報を戻します。これは、連絡先オブジェクトとして Microsoft Forefront Identity Manager 2010 (または以前のバージョンの製品) によりレプリケートされたユーザーです。Get-CsAdContact を使用すると、msRTCSIP-OriginatorSid 属性に値が構成されているすべてのユーザーを戻します。
構文
Get-CsAdContact [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LDAPFilter <String>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>]
解説
複数フォレスト トポロジで、他のフォレストのユーザーは連絡先として表されます。これらの連絡先は Active Directory の連絡先とは同じではありません。[Active Directory ユーザーとコンピューター] を使用して新しい連絡先を作成すると、Get-CsAdContact コマンドレットによって、そのユーザーは戻されません。代わりに Get-CsAdContact では、ホーム フォレスト以外のフォレストのユーザーの情報が戻されるだけです。複数フォレスト トポロジを使用していない場合は、Get-CsAdContact を呼び出す必要はありません
このコマンドレットを実行できるユーザー: 既定では、Get-CsAdContact コマンドレットをローカルで実行する権限があるのは、RTCUniversalUserAdmins、RTCUniversalServerAdmins、および RTCUniversalReadOnlyAdmins グループのメンバーです。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsAdContact"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
省略可能 |
UserId パラメーター |
戻す連絡先の Identity を示します。連絡先の Identity は、次の 3 つのうちいずれかの形式を使用して指定できます。使用できる形式は、1) 連絡先の SIP アドレス、2) 連絡先の Active Directory 識別名、および 3) 連絡先の Active Directory 表示名 (Ken Myer など) です。 連絡先の Identity として表示名を使用する場合は、アスタリスク (*) ワイルドカード文字を使用できます。たとえば、Identity が "* Smith" の場合、文字列値 "Smith" で終わる表示名を持つすべての連絡先が戻されます。 |
Credential |
省略可能 |
PSCredential オブジェクト |
別の資格情報で Get-CsAdContact コマンドレットを実行できます。Windows へのログオンに使用したアカウントに、連絡先オブジェクトの操作に必要な特権がない場合は、この操作が必要になる場合があります。 Credential パラメーターを使用するには、まず、Get-Credential コマンドレットを使用して、PSCredential オブジェクトを作成する必要があります。詳細については、Get-Credential のヘルプ トピックを参照してください。 |
DomainController |
省略可能 |
文字列 |
指定したドメイン コントローラーに接続して、連絡先情報を取得できます。特定のドメイン コントローラーに接続するには、DomainController パラメーターの後に、完全修飾ドメイン名 (たとえば、atl-cs-001.litwareinc.com) を追加します。 |
Filter |
省略可能 |
文字列 |
Microsoft Lync Server 2010 固有の属性をフィルター処理することで、戻りデータを制限できます。 Filter パラメーターは、Where-Object コマンドレットと同じ Windows PowerShell フィルター処理構文を使用します。たとえば、末尾が "fabrikam.com" で終わる SIP アドレスを持つ連絡先のみを戻すフィルターは、{SipAddress -like "*@fabrikam.com"} のようになります。ここで、SipAddress は Active Directory の属性、-like は比較演算子、"*@fabrikam.com" はフィルター値を表しています。 |
LdapFilter |
省略可能 |
文字列 |
Active Directory の一般属性をフィルタリングして、戻りデータを限定できます。たとえば、戻されるデータを、特定の部署に勤務していたり、特定のマネージャーや役職を持っていたりする連絡先に制限できます。 LdapFilter パラメーターでは、LDAP クエリ言語を使ってフィルターを作成します。たとえば、1-425-555-1298 という電話番号の連絡先を戻すフィルターは、"telephoneNumber=1-425-555-1298" のようになります。ここで、"telephoneNumber"は Active Directory の属性、"=" は比較演算子 (等しい)、"1-425-555-1298" はフィルター値を表しています。 |
OU |
省略可能 |
識別名 |
取得情報を特定の Active Directory 組織単位 (OU) またはコンテナーの情報に制限できます。このパラメーターを使用すると、指定の OU およびそのすべての子 OU からデータが戻されます。たとえば、財務 OU に 2 つの子 OU、AccountsPayable および AccountsReceivable がある場合、これら 3 つの OU それぞれから連絡先が戻されます。 OU 指定時には、該当コンテナーの識別名を使用します。次に例を示します。OU=Finance,dc=litwareinc,dc=com |
ResultSize |
省略可能 |
整数 |
このコマンドレットによって戻されるレコード数を制限できます。たとえば、(フォレスト内にいくつの連絡先があるかに関係なく) 7 つの連絡先を戻す場合は、ResultSize パラメーターを指定して、パラメーター値を 7 に設定します。ただし、どの 7 つの連絡先を戻すかを指定する方法はありません。 結果サイズは、0 ～ 2147483647 の範囲の整数に設定できます。0 に設定すると、コマンドは実行されますが、データは戻りません。ResultSize を 7 に設定してもフォレスト内に連絡先が 3 つしかない場合はその 3 つの連絡先が戻され、コマンドはエラーなく完了します。 |
入力の種類
文字列。Get-CsAdContact は、ユーザー アカウントの Identity を表す文字列値をパイプ処理で受け入れます。
戻り値の種類
Get-CsAdContact を実行すると、Microsoft.Rtc.Management.ADConnect.Schema.ADContact オブジェクトのインスタンスが戻されます。
例
-------------------------- 例 1 ------------------------
Get-CsAdContact
例 1 に示すコマンドでは、Active Directory ドメイン サービス (AD DS) に存在するすべての複数フォレストの連絡先のコレクションを戻しています。追加のパラメーターを使用しないで Get-CsAdContact を呼び出すと、すべての Active Directory の連絡先のすべてのプロパティの値が戻されます。
-------------------------- 例 2 ------------------------
Get-CsAdContact | Select-Object DisplayName, SipAddress
例 2 でも、すべての Active Directory の連絡先のコレクションを戻しています。ただしこの場合は、そのコレクションを Select-Object コマンドレットにパイプ処理し、画面に表示される次の 2 つの属性のみ指定します。DisplayName および SipAddress です。
-------------------------- 例 3 ------------------------
Get-CsAdContact -Identity "Ken Myer"
上記のコマンドでは、次に示す 1 つの Active Directory の連絡先の情報を戻しています。Identity が "Ken Myer" の連絡先です。
-------------------------- 例 4 ------------------------
Get-CsAdContact -LdapFilter "Organization=Fabrikam"
例 4 のコマンドでは、Fabrikam に勤務しているすべての Active Directory の連絡先を戻しています。これを行うため、Get-CsAdContact に LdapFilter パラメーターを指定して呼び出します。この例では、Organization 属性が "Fabrikam" に設定されている連絡先のみに戻りデータを限定しています。
-------------------------- 例 5 ------------------------
$x = Get-Credential -Credential "litwareinc\administrator"
Get-CsAdContact -Credential $x
例 5 に示す 2 つのコマンドでは Credential パラメーターを使用しており、これにより別の資格情報で Get-CsAdContact を実行できます。最初のコマンドでは、Get-Credential コマンドレットを呼び出し、アカウント litwareinc\administrator に対して PSCredential オブジェクトを作成しています。このコマンドでは、ユーザー litwareinc\administrator に対する [資格情報の要求] ダイアログ ボックスが表示されます。このアカウントのパスワードを入力すると、その資格情報が変数 $x に格納されます。2 番目のコマンドでは、Get-CsAdContact に Credential パラメーターを指定して呼び出します。パラメーター値 $x は、アカウント litwareinc\administrator の下で Get-CsAdContact を実行することを示します。