Set-CsPartnerApplication

Syntax

Set-CsPartnerApplication
   [-Identity] <XdsGlobalRelativeIdentity>
   -CertificateFileData <String>
   [-AcceptSecurityIdentifierInformation <Boolean>]
   [-ApplicationTrustLevel <ApplicationTrustLevel>]
   [-Confirm]
   [-Enabled <Boolean>]
   [-Force]
   [-Tenant <Guid>]
   [-WhatIf]
   [<CommonParameters>]

Set-CsPartnerApplication
   [-Identity] <XdsGlobalRelativeIdentity>
   -CertificateRawData <String>
   [-AcceptSecurityIdentifierInformation <Boolean>]
   [-ApplicationTrustLevel <ApplicationTrustLevel>]
   [-Confirm]
   [-Enabled <Boolean>]
   [-Force]
   [-Tenant <Guid>]
   [-WhatIf]
   [<CommonParameters>]

Set-CsPartnerApplication
   [-Identity] <XdsGlobalRelativeIdentity>
   [-AcceptSecurityIdentifierInformation <Boolean>]
   [-ApplicationTrustLevel <ApplicationTrustLevel>]
   [-Confirm]
   [-Enabled <Boolean>]
   [-Force]
   [-Tenant <Guid>]
   [-WhatIf]
   [<CommonParameters>]

Set-CsPartnerApplication
   [-Identity] <XdsGlobalRelativeIdentity>
   [-UseOAuthServer]
   [-AcceptSecurityIdentifierInformation <Boolean>]
   [-ApplicationTrustLevel <ApplicationTrustLevel>]
   [-Confirm]
   [-Enabled <Boolean>]
   [-Force]
   [-Tenant <Guid>]
   [-WhatIf]
   [<CommonParameters>]

Set-CsPartnerApplication
   [-Identity] <XdsGlobalRelativeIdentity>
   -MetadataUrl <String>
   [-AcceptSecurityIdentifierInformation <Boolean>]
   [-ApplicationTrustLevel <ApplicationTrustLevel>]
   [-Confirm]
   [-Enabled <Boolean>]
   [-Force]
   [-Tenant <Guid>]
   [-WhatIf]
   [<CommonParameters>]

Set-CsPartnerApplication
   [-Confirm]
   [-Force]
   [-Instance <PSObject>]
   [-WhatIf]
   [<CommonParameters>]

Description

In Skype for Business Server, server-to-server authentication (for example, the authentication that enables Skype for Business Server and Exchange 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 Skype for Business Server and you need to communicate with another server product that fully supports the OAuth protocol (for example, Exchange or SharePoint) 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) as a partner application. (You will also need to configure Skype for Business Server as a partner application for the other server product.) In Skype for Business Server, partner applications are managed by using the CsPartnerApplication cmdlets.

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

Examples

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

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

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

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

Get-CsPartnerApplication | ForEach-Object {Set-CsPartnerApplication -Identity $_.Identity -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.

-------------------------- Example 3 --------------------------

Get-CsPartnerApplication | Where-Object {$_.ApplicationTrustLevel -eq "User"} | 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.

Parameters

-AcceptSecurityIdentifierInformation

-ApplicationTrustLevel

-CertificateFileData

-CertificateRawData

-Confirm

-Enabled

-Force

-Identity

-Instance

-MetadataUrl

-Tenant

-UseOAuthServer

-WhatIf

Inputs

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

Outputs

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

Related Links

• Get-CsPartnerApplication
• New-CsPartnerApplication
• Remove-CsPartnerApplication