Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-19
Use the Set-PartnerApplication cmdlet to configure a partner application.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Set-PartnerApplication [-ApplicationIdentifier
<String>] [-Realm <String>] <COMMON
PARAMETERS>
|
Set-PartnerApplication [-AuthMetadataUrl <String>]
[-TrustAnySSLCertificate <SwitchParameter>] <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>]]
|
Examples
EXAMPLE 1
This example refreshes the auth metadata for the HRApp partner application.
 Copy Code |
|
|---|---|
Set-PartnerApplication HRApp -RefreshAuthMetadata |
|
Detailed Description
In Microsoft Exchange Server 2013, you can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange 2013 resources. For details, see Integration with SharePoint and Lync. We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the \Exchange Server\V15\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.
Parameters
| 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 |
|
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 |
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 can be used to suppress the
confirmation prompt that appears by default when this cmdlet is
run. To suppress the confirmation prompt, use the syntax
|
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
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 |
|
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 |
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 2013 resources. |
|
RefreshAuthMetadata |
Optional |
System.Management.Automation.SwitchParameter |
The RefreshAuthMetadata switch specifies that the auth metadata should be refreshed from the authorization server. |
|
TrustAnySSLCertificate |
Optional |
System.Management.Automation.SwitchParameter |
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 instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
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.
Return Types
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.