Export (0) Print
Expand All
Expand Minimize

Remove-CsPartnerApplication

Lync Server 2013
 

Topic Last Modified: 2013-03-07

Removes an existing partner application. A partner application is any application that Lync Server 2013 can directly exchange security tokens with, without having to go through a third-party security token server. This cmdlet was introduced in Lync Server 2013.

Remove-CsPartnerApplication -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Tenant <Guid>] [-WhatIf [<SwitchParameter>]]

The command shown in Example 1 deletes the partner application with the Identity "MicrosoftExchange".

Remove-CsPartnerApplication -Identity "MicrosoftExchange"

In Example 2, all the partner applications configured for use in the organization are deleted. To do this, the command first uses the Get-CsPartnerApplication cmdlet in order to return a collection of all the partner applications. This collection is then piped to the Remove-CsPartnerApplication cmdlet, which deletes each application in the collection.

Get-CsPartnerApplication | Remove-CsPartnerApplication

In Example 3, all the partner applications where the trust level is set to anything other than Full are deleted. To carry out this task, the command first calls the Get-CsPartnerApplication cmdlet without any parameters in order to return a collection of all the partner applications configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those applications where the ApplicationTrustLevel property is not equal to (-ne) "Full". The applications that meet that criterion are then piped to, and removed by, the Remove-CsPartnerApplication cmdlet.

Get-CsPartnerApplication | Where-Object {$_.ApplicationTrustLevel -ne "Full"} | Remove-CsPartnerApplication

In Lync Server 2013, server-to-server authentication (for example, the authentication that enables Lync Server 2013 and Exchange 2013 to share information) is carried out using the OAuth security protocol. This type of authentication typically requires three servers: the two servers that need to communicate with one another (Server A and B) and a third-party security token server. If Servers A and B need to communicate with one another, the two servers contact the token server (also known as an OAuth server) and obtain mutually-trusted security tokens that the two servers can exchange in order to prove their identities.

If you are using an on-premises version of Lync Server 2013 and you need to communicate with another server product that fully supports the OAuth protocol (for example, Exchange 2013 or Microsoft SharePoint 2013) then you typically do not need to use a token server; that's because these server products are able to issue their own security tokens. However, you will need to configure the other server product (e.g., Exchange 2013) as a partner application. (You will also need to configure Lync Server 2013 as a partner application for the other server product.) In Lync Server 2013, partner applications are managed by using the CsPartnerApplication cmdlets.

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 command-line interface prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsPartnerApplication"}

Lync Server Control Panel: The functions carried out by the Remove-CsPartnerApplication cmdlet are not available in the Lync Server Control Panel.

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity

Unique identifier of the partner application to be removed. For example:

-Identity "MicrosoftExchange"

Note that you cannot use wildcard characters when specifying an Identity.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses the display of any non-fatal error message that might occur when running the command.

Tenant

Optional

System.Guid

Globally unique identifier (GUID) of the Lync Online tenant account for the partner application being deleted. For example:

–Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"

You can return the tenant ID for each of your tenants by running this command:

Get-CsTenant | Select-Object DisplayName, TenantID

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

The Remove-CsPartnerApplication cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated object.

None. Instead, the Remove-CsPartnerApplication cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated object.

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