Export (0) Print
Expand All
Expand Minimize

Set-CsPartnerApplication

Lync Server 2013
 

Topic Last Modified: 2013-03-25

Modifies an existing partner application. A partner application is any application that Lync Online 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.

Set-CsPartnerApplication -Identity <XdsGlobalRelativeIdentity> [-AcceptSecurityIdentifierInformation <$true | $false>] [-ApplicationTrustLevel <User | Application | Full>] [-Enabled <$true | $false>] [-Tenant <Guid>] <COMMON PARAMETERS>
Set-CsPartnerApplication -Identity <XdsGlobalRelativeIdentity> -MetadataUrl <String> [-AcceptSecurityIdentifierInformation <$true | $false>] [-ApplicationTrustLevel <User | Application | Full>] [-Enabled <$true | $false>] [-Tenant <Guid>] <COMMON PARAMETERS>
Set-CsPartnerApplication -CertificateRawData <String> -Identity <XdsGlobalRelativeIdentity> [-AcceptSecurityIdentifierInformation <$true | $false>] [-ApplicationTrustLevel <User | Application | Full>] [-Enabled <$true | $false>] [-Tenant <Guid>] <COMMON PARAMETERS>
Set-CsPartnerApplication -CertificateFileData <String> -Identity <XdsGlobalRelativeIdentity> [-AcceptSecurityIdentifierInformation <$true | $false>] [-ApplicationTrustLevel <User | Application | Full>] [-Enabled <$true | $false>] [-Tenant <Guid>] <COMMON PARAMETERS>
Set-CsPartnerApplication -Identity <XdsGlobalRelativeIdentity> -UseOAuthServer <SwitchParameter> [-AcceptSecurityIdentifierInformation <$true | $false>] [-ApplicationTrustLevel <User | Application | Full>] [-Enabled <$true | $false>] [-Tenant <Guid>] <COMMON PARAMETERS>
Set-CsPartnerApplication [-Instance <PSObject>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

The command shown in Example 1 disables the partner application MicrosoftExchange. This is done by setting the Enabled property to False ($False).

Set-CsPartnerApplication -Identity "MicrosoftExchange" -Enabled $False

In Example 2, all the partner applications currently in use in the organization are disabled. To do this, the command first uses the Get-CsPartnerApplication cmdlet to return a collection of all the partner applications. This collection is then piped to the ForEach-Object cmdlet. In turn, the ForEach-Object cmdlet runs the Set-CsPartnerApplication cmdlet against each application in the collection. Doing so disables each of those partner applications.

Get-CsPartnerApplication | ForEach-Object {Set-CsPartnerApplication -Identity $_.Identity -Enabled $False}

Example 3 disables all partner applications where the ApplicationTrustLevel property is set to User. To carry out this task, the command first calls the Get-CsPartnerApplication cmdlet without any parameters; that returns a collection of all the partner applications configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those applications where the ApplicationTrustLevel property is equal to "User". That filtered collection is then piped to the ForEach-Object cmdlet, which uses the Set-CsPartnerApplication cmdlet to take each item in the collection and set the Enabled property to $False.

Get-CsPartnerApplication | Where-Object {$_.ApplicationTrustLevel -eq "User"} | ForEach-Object {Set-CsPartnerApplication -Identity $_.Identity -Enabled $False}

In Lync Online, 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 "Set-CsPartnerApplication"}

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

 

Parameter Required Type Description

CertificateFileData

Required

String

Path to a certificate file that can be assigned to the partner application. For example:

-CertificateFileData "C:\Certificates\PartnerApplication.cer"

CertificateRawData

Required

String

Certificate (in Base64 encoded format) that can be assigned to the partner application. To read raw data from a certificate and then convert that data to the required format, use commands similar to these:

$x = Get-Content "C:\Certificates\PartnerApplication.cer" –Encoding Byte

$y = [Convert]::ToBase64String($x)

You can then use this syntax to assign the certificate data stored in the variable $y:

-CertificateRawData $y

Identity

Required

XdsGlobalRelativeIdentity

Unique identifier of the partner application. For example:

-Identity "MicrosoftExchange"

MetadataUrl

Required

String

URL of the security token servicer federation metadata that carries the signing keys, the issuer identifier, and the issuer endpoint URL.

UseOAuthServer

Optional

SwitchParameter

When present, the partner application will use the configured OAuth Server for server-to-server authentication. When not present, the partner application will use its built-in security token service for server-to-server authentication.

AcceptSecurityIdentifierInformation

Optional

Boolean

When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. The default value is False.

ApplicationTrustLevel

Optional

ApplicationTrustLevel

Specifies the level of trust between Lync Server 2013 and the partner application. Allowed values are:

* Full -- The partner application is trusted to represent itself and to impersonate any user in the realm. This is the default value.

* Application -- The partner application is trusted to represent itself within the realm. In order to impersonate a user, it must obtain consent through from a security token server.

* User -- The partner application must obtain consent from a security token server in order to represent a user, and cannot represent itself.

The default value is Full.

Confirm

Optional

SwitchParameter

Prompts you for confirmation before executing the command.

Enabled

Optional

Boolean

When set to True, the partner application is available for use with Lync Server 2013. When set to False the partner application will continue to run, but will not be able to communicate with Lync Server until the Enabled property has been set to True.

Force

Optional

SwitchParameter

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

Instance

Optional

PSObject

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

Tenant

Optional

Guid

Globally unique identifier (GUID) of the Lync Online tenant account for the partner application being modified. 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

SwitchParameter

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

None. The Set-CsPartnerApplication cmdlet does not accept pipelined input.

None. Instead, the Set-CsPartnerApplication cmdlet modifies 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