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) から 1 つまたは複数のアプリケーションの連絡先を取得します。これらのオブジェクトは、Active Directory 内で、RTC サービスの、アプリケーションの連絡先コンテナー内に格納されます。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが Get-CsApplicationEndpoint コマンドレットをローカルで実行することを承認されています。RTCUniversalUserAdmins、RTCUniversalServerAdmins、RTCUniversalReadOnlyAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsApplicationEndpoint"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
省略可能 |
UserIdParameter |
取得するアプリケーション エンドポイントの Identity、SIP アドレス、または表示名です。Identity はエンドポイントの識別名で構成されます。通常、この識別名には CN={8811fefe-e0bb-4fab-ae39-7aaeddd423dc},CN=Application Contacts,CN=RTC Service,CN=Services,CN=Configuration,DC=Vdomain,DC=com のように、CN の一部としてグローバル一意識別子 (GUID) が含まれます。 |
ApplicationId |
省略可能 |
文字列 |
取得するアプリケーション エンドポイントのアプリケーション ID です。アプリケーション ID は、エンドポイントの OwnerUrn プロパティの値です。たとえば、OwnerUrn プロパティの値が urn:application:Caa の場合、アプリケーション ID は urn:application:Caa となります。ただしエンドポイントを取得する際には、サフィックス (この場合は Caa) しか入力できません。次に例を示します。-ApplicationId Caa |
Credential |
省略可能 |
PSCredential |
取得操作を処理するための別の資格情報です。Windows PowerShell コマンドレットの Get-Credential を呼び出して、PSCredential オブジェクトを取得できます。 |
DomainController |
省略可能 |
Fqdn |
ドメイン コントローラーを指定できます。ドメイン コントローラーを指定しない場合は、最初に使用可能なものが使用されます。 |
Filter |
省略可能 |
文字列 |
Microsoft Lync Server 2010 固有の属性をフィルター処理することで、戻されるデータを制限できます。たとえば戻されるデータを、表示名や SIP アドレスが特定のワイルドカード パターンと一致する連絡先に限定することができます。 Filter パラメーターは、Where-Object コマンドレットと同じ Windows PowerShell フィルター処理構文を使用します。たとえば、エンタープライズ VoIP が有効になっている連絡先のみを戻すフィルターは、{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 では、表示名のいずれかの箇所に “エンドポイント” という文字列が含まれるアプリケーション エンドポイントをすべて取得します。上記の操作を実行するため、このコマンドでは Filter パラメーターを使用します。パラメーター値を指定すると、フィルター処理が実行され、表示名 (DisplayName) に "エンドポイント" という文字列が含まれる (-like) エンドポイント オブジェクトが検索されます (*endpoint* というワイルドカード文字は、"エンドポイント" という文字列の前後に文字が入ってもかまわないことを示しています。つまり、表示名のどの箇所に "エンドポイント" がある場合でも検索されます)。
-------------------------- 例 4 ------------------------
Get-CsApplicationEndpoint -ApplicationId tapp2 | Select-Object Identity, SipAddress, DisplayName, OwnerUrn
例 4 では、urn:application:tapp2 というアプリケーションに関連付けられているすべてのアプリケーション エンドポイントを戻します。これは、ApplicationId パラメーターに tapp2 という ID を渡して実行します。プールの FQDN を入力しなかった点にご注意ください。この結果、tapp2 という ID を持つアプリケーションが複数のプールに存在する場合は、これらのアプリケーションすべてのエンドポイントが取得されます。このコマンドの次の部分で、戻された 1 つまたは複数のオブジェクトが Select-Object コマンドレットにパイプ処理されます。その結果、これらのオブジェクトの Identity、SipAddress、DisplayName、および OwnerUrn プロパティが表示されます。