Get-CsExUmContact
トピックの最終更新日: 2012-03-23
1 つ以上のホスト型 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 を使用して連絡先オブジェクトを作成し、自動応答やサブスクライバー アクセスの機能を適用する必要があります。このコマンドレットはこれら連絡先の 1 つ以上を取得します。
このコマンドレットを実行できるユーザー: 既定では、Get-CsExUmContact コマンドレットをローカルで実行する権限があるのは、RTCUniversalUserAdmins、RTCUniversalServerAdmins、および RTCUniversalReadOnlyAdmins グループのメンバーです。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsExUmContact"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
省略可能 |
UserIdParameter |
取得する連絡先オブジェクトの一意の識別子です。連絡先 ID は、以下の 4 つの形式のうちの 1 つを使用して指定できます。1) 連絡先の SIP アドレス、2) 連絡先のユーザー プリンシパル名 (UPN)、3) ドメイン\ログオン形式 (litwareinc\exum1 など) の連絡先のドメイン名とログオン名、および 4) 連絡先の Active Directory 表示名 (Team Auto Attendant など)。 完全なデータ型: Microsoft.Rtc.Management.AD.UserIdParameter |
Filter |
省略可能 |
文字列 |
Lync Server 2010 固有の属性をフィルター処理することで、返りデータを制限できます。たとえば、"tel:555" で始まる URI の行のある連絡先に戻りデータを制限できます。 Filter パラメーターは、Where-Object コマンドレットの Windows PowerShell フィルター処理構文のサブセットを使用します。たとえば、エンタープライズ VoIP が有効になっている連絡先のみを戻すフィルターの場合、{EnterpriseVoiceEnabled -eq $True} のようになります。ここで、EnterpriseVoiceEnabled は Active Directory の属性を、-eq は比較演算子 (equal to) を、$True (組み込みの Windows PowerShell 変数) はフィルター値を表します。 |
LdapFilter |
省略可能 |
文字列 |
"一般的な" Active Directory 属性 (つまり、Lync Server 固有ではない属性) をフィルター処理することで、戻りデータを制限できます。 LdapFilter パラメーターでは、LDAP クエリ言語を使ってフィルターを作成します。 |
Credential |
省略可能 |
PSCredential |
別の資格情報でコマンドレットを実行できます。Windows へのログオンに使用したアカウントに、連絡先オブジェクトの操作に必要な特権がない場合は、この操作が必要になる場合があります。 Credential パラメーターを使用するには、まず Get-Credential コマンドレットを呼び出して、PSCredential オブジェクトを作成する必要があります。 |
DomainController |
省略可能 |
Fqdn |
指定したドメイン コントローラーに接続して、連絡先情報を取得できます。特定のドメイン コントローラーに接続するには、DomainController パラメーターの後に、コンピューター名 (たとえば、atl-mcs-001 など) またはその完全修飾ドメイン名 (たとえば、atl-mcs-001.litwareinc.com など) を指定します。 完全なデータ型: Microsoft.Rtc.Management.Deploy.Fqdn |
OU |
省略可能 |
OUIdParameter |
取得する情報を、特定の Active Directory 組織単位 (OU) の情報に限定できます。このパラメーターにより、指定の OU およびその子 OU すべてからデータが戻ります。 OU を指定する際には、そのコンテナーの識別名 (OU=ExUmContacts,dc=litwareinc,dc=com など) を使用します。 |
ResultSize |
省略可能 |
整数 |
コマンドによって戻されるレコード数を制限できます。たとえば、(フォレスト内にいくつの連絡先があるかに関係なく) 7 つの連絡先のみを戻す場合は、単に ResultSize パラメーターを指定して、パラメーターの値を 7 に設定します。どの 7 つの連絡先を戻すかは指定できないことに注意してください。フォレスト内に 3 つの連絡先しかない場合は、ResultSize を 7 に設定してもその 3 つの連絡先が戻され、エラーなしでコマンドが完了します。 結果サイズは、0 ～ 2147483647 の範囲の整数に設定できます。0 に設定すると、コマンドは実行されますが、データは戻りません。 完全なデータ型: Microsoft.Rtc.Management.ADConnect.Core.Unlimited |
入力の種類
文字列。Exchange UM 連絡先オブジェクトの Identity を表す文字列値を、パイプ処理で受け入れます。
戻り値の種類
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 プロパティをフィルター処理して、このプロパティの値が False ($False) に等しい (-eq) かどうかを確認します。このコマンドによって戻される連絡先は機能しません。
-------------------------- 例 4 --------------------------
Get-CsExUmContact -Filter {LineURI -like "tel:555*"}
このコマンドは、LineURI プロパティをフィルター処理して、tel:555 で始まる LineURI のあるすべての 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 の連絡先を取得します。