Set-CsTrustedApplicationEndpoint
Modifies an existing endpoint contact for a trusted application. This cmdlet was introduced in Lync Server 2010.
Syntax
Set-CsTrustedApplicationEndpoint
[-Identity] <UserIdParameter>
[-DisplayName <String>]
[-DisplayNumber <String>]
[-Enabled <Boolean>]
[-EnabledForFederation <Boolean>]
[-EnterpriseVoiceEnabled <Boolean>]
[-LineURI <String>]
[-PrimaryLanguage <String>]
[-SecondaryLanguages <Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String]>]
[-SipAddress <String>]
[-Type <String>]
[-PassThru]
[-WhatIf]
[-Confirm]
[-ExchangeArchivingPolicy <ExchangeArchivingPolicyOptionsEnum>]
[<CommonParameters>] 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 Domain Services.
Examples
-------------------------- Example 1 ------------------------
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 ------------------------
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 the Get-CsTrustedApplicationEndpoint cmdlet 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.
Parameters
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-DisplayName
The display name of the endpoint contact object.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-DisplayNumber
The telephone number of the contact as it will appear in the Address Book.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Enabled
Determines whether the contact is enabled for Skype for Business Server.
Default: True
| Type: | Boolean |
| Aliases: | CsEnabled |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-EnabledForFederation
Determines whether federated users have access to this contact.
Default: False
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-EnterpriseVoiceEnabled
Determines whether the contact is enabled for Enterprise Voice.
Default: True
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-ExchangeArchivingPolicy
Indicates where the contact's instant messaging sessions are archived. Allowed values are:
- Uninitialized
- UseLyncArchivingPolicy
- ArchivingToExchange
- NoArchiving
| Type: | ExchangeArchivingPolicyOptionsEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Identity
The Identity (the distinguished name) or the SIP address of the application endpoint to be modified.
| Type: | UserIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-LineURI
The phone number of the contact. Must be in the format TEL:<number>, for example TEL:+14255551212.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-PassThru
Including this parameter will cause the cmdlet to not only modify the contact object but will return the new object as output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-PrimaryLanguage
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-SecondaryLanguages
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".
| Type: | Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-SipAddress
You cannot modify the SIP address of a contact. The SIP address is assigned when the application endpoint is created.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Type
This parameter is not used with this cmdlet.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact object. Accepts pipelined input of trusted application endpoint objects.
Outputs
This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact.