TechNet
Export (0) Print
Expand All

Set-PartnerApplication

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-PartnerApplication cmdlet to configure partner application configurations.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-PartnerApplication [-AuthMetadataUrl <String>] [-TrustAnySSLCertificate <SwitchParameter>] <COMMON PARAMETERS>

Set-PartnerApplication [-ApplicationIdentifier <String>] [-Realm <String>] <COMMON PARAMETERS>

Set-PartnerApplication [-RefreshAuthMetadata <SwitchParameter>] <COMMON PARAMETERS>

COMMON PARAMETERS: -Identity <PartnerApplicationIdParameter> [-AcceptSecurityIdentifierInformation <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-LinkedAccount <UserIdParameter>] [-Name <String>] [-WhatIf [<SwitchParameter>]]

This example refreshes the auth metadata for the HRApp partner application.

Set-PartnerApplication HRApp -RefreshAuthMetadata

You can configure partner applications such as MicrosoftSharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see Integration with SharePoint and Lync. We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Partner applications - configure" entry in the Sharing and collaboration permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.PartnerApplicationIdParameter

The Identity parameter specifies the identity of the partner application you want to modify.

AcceptSecurityIdentifierInformation

Optional

System.Boolean

The AcceptSecurityIdentifierInformation parameter specifies whether Exchange should accept security identifiers (SIDs) from another trusted Active Directory forest for the partner application. By default, new partner applications are configured to not accept SIDs from another forest. If you're in deployment with a trusted forest, set the parameter to $true.

ApplicationIdentifier

Optional

System.String

The ApplicationIdentifier parameter specifies a unique application identifier for the partner application that uses an authorization server.

AuthMetadataUrl

Optional

System.String

This parameter is available only in on-premises Exchange 2016.

The AuthMetadataUrl parameter specifies the URL that Exchange can retrieve the AuthMetadata document from for a partner application that doesn't use an authorization server.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether the partner application is enabled. By default, new partner applications are enabled. Set the parameter to $false to create the application configuration in a disabled state.

LinkedAccount

Optional

Microsoft.Exchange.Configuration.Tasks.UserIdParameter

The LinkedAccount parameter specifies a linked Active Directory user account for the application. Exchange evaluates Role Based Access Control (RBAC) permissions for the linked account when authorizing a token used to perform a task.

Name

Optional

System.String

The Name parameter specifies a new name for the partner application.

Realm

Optional

System.String

This parameter is available only in on-premises Exchange 2016.

The Realm parameter specifies a security realm for the partner application. If the token is from a domain that's not an accepted domain, Exchange checks the realm specified in the token. In such a scenario, only tokens with the same realm specified in the partner application can access Exchange resources.

RefreshAuthMetadata

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2016.

The RefreshAuthMetadata switch specifies that the auth metadata should be refreshed from the authorization server.

TrustAnySSLCertificate

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2016.

The TrustAnySSLCertificate switch specifies whether Exchange should trust certificates issued by a certification authority (CA) not trusted by the server. We don't recommend using this switch in a production environment.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show:
© 2016 Microsoft