Retrieves the settings for a trusted application.
Syntax
Get-CsTrustedApplication [-Identity <ExternalApplicationIdentity>] |
Get-CsTrustedApplication [-Filter <String>] |
Get-CsTrustedApplication [-ApplicationId <String>] [-TrustedApplicationPoolFqdn <String>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
ExternalApplicationIdentity |
The unique identifier of the trusted application you want to retrieve. Identity values must be entered in the format <pool FQDN>/<application ID>, where pool FQDN is the fully qualified domain name (FQDN) of the pool on which the application resides, and application ID is the name of the application. Note that if you specify an Identity, you cannot specify an ApplicationID or a TrustedApplicationPoolFqdn. |
|
Filter |
Optional |
String |
A string that includes wildcards that allows you to retrieve trusted applications based on Identity values that match the given wildcard string. Identities consist of a trusted application pool FQDN followed by a slash (/) followed by the trusted application ID. The Filter value will match any part of the Identity, both the FQDN and the application ID. |
|
ApplicationId |
Optional |
String |
The name of the application. If you supply a value for ApplicationId, you cannot supply a value for the Identity, but you must supply a value for the TrustedApplicationPoolFqdn parameter. |
|
TrustedApplicationPoolFqdn |
Optional |
String |
The FQDN of the trusted application pool on which the application will reside. If you supply a value for TrustedApplicationPoolFqdn, you cannot supply a value for the Identity, but you must supply a value for the ApplicationID parameter. |
Detailed Description
A trusted application is an application developed by another party that is given trusted status to run as part of Microsoft Communications Server 2010 but that is not a built-in part of the product. This cmdlet allows you to retrieve port and Globally Routable User Agent URI (GRUU) settings for one or more trusted applications.
When you use this cmdlet to retrieve a single trusted application, you must supply a value for the Identity parameter. The Identity is the fully qualified domain name (FQDN) of the pool on which the application is homed followed by a slash (/) followed by the application ID. For example, TrustPool.litwareinc.com/tapp2, where TrustPool.litwareinc.com is the pool FQDN and tapp2 is the application ID. Note that when you retrieve an application by calling this cmdlet, you’ll see an ID that looks more like this: TrustPool.litwareinc.com/urn:application:tapp2. Notice the prefix urn:application: before the application name (tapp2). While this prefix is part of the Identity, it’s not required when you specify the value for the Identity parameter.
Return Types
Returns an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplication.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsTrustedApplication |
|
This example retrieves information about all trusted applications defined within the Communications Server 2010 deployment.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 |
|
Example 2 retrieves the trusted application with the Identity TrustPool.litwareinc.com/tapp2.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsTrustedApplication -Filter *trust* |
|
Example 3 retrieves all trusted applications that have identities matching the wildcard string specified as the Filter value. In this case, with a Filter value of *trust*, the command will retrieve all trusted applications with the string “trust” anywhere within the Identity. This string can be contained within any part of the Identity, the pool FQDN, or the application ID. So this command will retrieve trusted applications with identities such as TrustedPool.litwareinc.com/application1, Pool1.litwareinc.com/trustedapp, and Pool1.litwareinc.com/trust.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsTrustedApplication -ApplicationId tapp2 -TrustedApplicationPoolFqdn TrustPool.litwareinc.com |
|
Example 4 will return the same results as Example 2 (where the Identity was specified as the only parameter). The only difference between the two examples is that Example 2 retrieves the trusted application based on the Identity, which consists of the trusted pool FQDN followed by the application ID. In this example, the application ID and trusted pool FQDN are entered as values to two separate parameters: ApplicationId and TrustedApplicationPoolFqdn.
-------------------------- Example 5 ------------------------
| Copy Code |
|
|---|---|
Get-CsTrustedApplication | Where-Object {$_.TrustedApplicationPoolFqdn -eq "TrustPool.litwareinc.com"}
|
|
Example 5 retrieves all the trusted applications on the pool TrustPool.litwareinc.com. The example begins by calling the Get-CsTrustedApplication cmdlet. This returns a collection of all trusted applications defined within the Communications Server deployment. This collection is then piped to the Where-Object cmdlet, which looks through the collection item-by-item to find those with a TrustedApplicationPoolFqdn property value equal to (-eq) TrustPool.litwareinc.com.