Modifies an existing endpoint contact for a trusted application.
Syntax
Set-CsTrustedApplicationEndpoint -Identity <UserIdParameter> [-Confirm [<SwitchParameter>]] [-CSEnabled <$true | $false>] [-DisplayName <String>] [-DisplayNumber <String>] [-EnabledForFederation <$true | $false>] [-EnterpriseVoiceEnabled <$true | $false>] [-LineURI <String>] [-PassThru <SwitchParameter>] [-PrimaryLanguage <String>] [-SecondaryLanguages <MultiValuedProperty>] [-SipAddress <String>] [-Type <String>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
UserIdParameter |
The Identity or the SIP address of the application endpoint to be modified. The Identity consists of the distinguished name of the contact. |
|
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
|
CSEnabled |
Optional |
Boolean |
Determines whether the contact is enabled for Communications Server. Default: True |
|
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. |
|
EnabledForFederation |
Optional |
Boolean |
Determines whether federated users have access to this contact. Default: False |
|
EnterpriseVoiceEnabled |
Optional |
Boolean |
Determines whether the contact is enabled for Enterprise Voice. Default: True |
|
LineURI |
Optional |
String |
The phone number of the contact. Must be in the format TEL:<number>, for example TEL:+14255551212. |
|
PassThru |
Optional |
SwitchParameter |
Including the parameter will cause the cmdlet to not only modify the contact object but will return the new object as output. |
|
PrimaryLanguage |
Optional |
Int32 |
|
|
SecondaryLanguages |
Optional |
MultiValuedProperty |
|
|
SipAddress |
Optional |
String |
You cannot modify the SIP address of a contact. |
|
Type |
Optional |
String |
|
|
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Detailed Description
A trusted application endpoint is an Active Directory contact object that enables routing of calls to a trusted application. This cmdlet modifies an existing endpoint contact object in Active Directory.
Return Types
This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Set-CsTrustedApplicationEndpoint -Identity "sip:endpoint1@litwareinc.com" -DisplayName "Endpoint 1" |
|
This example modifies the application endpoint contact object with the SIP address endpoint1@litwareinc.com. Notice that the Identity value begins with the string sip: followed by the SIP address. The next parameter, DisplayName, is given a value of “Endpoint 1”, which changes the display name of the contact to that value.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsTrustedApplicationEndpoint -Identity "Endpoint 1" | Set-CsTrustedApplicationEndpoint -DisplayNumber "(425)555-1212" |
|
This example modifies the display number of the endpoint application with the display name Endpoint 1. The command begins with a call to Get-CsTrustedApplicationEndpoint with an Identity of Endpoint 1. This retrieves the endpoint contact object with that display name. This object is then piped to the Set-CsTrustedApplicationEndpoint cmdlet, which modifies the DisplayNumber to the value, in this case, (425)555-1212.