Export (0) Print
Expand All
Expand Minimize

New-CsTrustedApplicationEndpoint

 

Topic Last Modified: 2012-03-25

Creates a new endpoint contact for a trusted application.

New-CsTrustedApplicationEndpoint -ApplicationId <String> -TrustedApplicationPoolFqdn <Fqdn> [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DisplayNumber <String>] [-LineURI <String>] [-PassThru <SwitchParameter>] [-PrimaryLanguage <String>] [-SecondaryLanguages <MultiValuedProperty>] [-SipAddress <String>] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]]

A trusted application endpoint is an Active Directory contact object that enables routing of calls to a trusted application. This cmdlet creates a new endpoint contact object in Active Directory Domain Services (AD DS) for a specified application.

Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsTrustedApplicationEndpoint cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsTrustedApplicationEndpoint"}

 

Parameter Required Type Description

ApplicationId

Required

String

The application ID of the trusted application for which the endpoint contact is being created. An application with this ID must already exist. Note that you may include only the name part of the application ID, you don’t need to (but you can) include the prefix information. For example, if the application ID is urn:application:TrustedApp1 you only need to pass the string TrustedApp1 to this parameter.

TrustedApplicationPoolFqdn

Required

Fqdn

The fully qualified domain name (FQDN) of the trusted application pool associated with the application. The application must already be associated with this pool for the endpoint to be created.

SipAddress

Optional

String

A SIP address for the new contact object. If you do not include a value for this parameter a SIP address will be auto-generated in the format sip:RtcApplication-<GUID>.<domain>, for example sip:RtcApplication-fbf9e2d1-c6aa-45a3-a045-b92d4ef961b2@litwareinc.com. The domain will be the default SIP domain.

DisplayName

Optional

String

The display name of the endpoint contact object.

DisplayNumber

Optional

String

The telephone number of the contact as it will appear in the Address Book.

LineURI

Optional

String

The phone number of the contact. Must be in the format TEL:<number>, for example TEL:+14255551212.

PrimaryLanguage

Optional

Int32

The primary language used for the trusted application. The language must be configured using a valid language code, such as en-US (U.S. English), fr-FR (French), etc.

SecondaryLanguages

Optional

Int32[]

A collection of languages that can also be used for trusted applications. Values must be configured as a comma-separated values list of language codes. For example, the following syntax sets French Canadian and French as secondary languages: -SecondaryLanguages "fr-CA","fr-FR".

Tenant

Optional

GUID

The globally unique identifier (GUID) of the object. This parameter is not used for on-premises deployments.

PassThru

Optional

SwitchParameter

Returns the results of this command. Running this cmdlet will display the newly created object; including this parameter will simply repeat that output, making the use of this parameter redundant.

WhatIf

Optional

SwitchParameter

Describes what would happen if you executed the command without actually executing the command.

Confirm

Optional

SwitchParameter

Prompts you for confirmation before executing the command.

Creates an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact.

-------------------------- Example 1 ------------------------

New-CsTrustedApplicationEndpoint -ApplicationId tapp1 -TrustedApplicationPoolFqdn TrustPool.litwareinc.com

This example creates a trusted application endpoint for the application with the Application ID tapp1 homed on the pool TrustPool.litwareinc.com. ApplicationID and TrustedApplicationPoolFqdn are the only parameters that are required to create a trusted application endpoint. However, keep in mind that assigning values to only these two parameters will auto-generate a SIP address for the contact. In order to ensure the SIP address is unique, the auto-generated address will include a globally unique identifier (GUID) and will look something like this: sip:RtcApplication-fbf9e2d1-c6aa-45a3-a045-b92d4ef961b2@litwareinc.com. If you’d like a more readable SIP address, see Example 2.

-------------------------- Example 2 ------------------------

New-CsTrustedApplicationEndpoint -ApplicationId tapp1 -TrustedApplicationPoolFqdn TrustPool.litwareinc.com -SipAddress sip:endpoint1@litwareinc.com

Example 2 is identical to Example 1 in that it creates a trusted application endpoint for the application with the Application ID tapp1 on the TrustPool.litwareinc.com pool. Unlike Example 1, we include one more parameter in our endpoint creation: SipAddress. Rather than allowing the system to generate a SIP address, we’ve specified an address of endpoint1@litwareinc.com.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft