Export (0) Print
Expand All

New-PartnerApplication

Exchange Online
 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-14

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

Use the New-PartnerApplication cmdlet to create a partner application configuration.

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

New-PartnerApplication -ApplicationIdentifier <String> [-Realm <String>] <COMMON PARAMETERS>
New-PartnerApplication -AuthMetadataUrl <String> [-TrustAnySSLCertificate <SwitchParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: -Name <String> [-AcceptSecurityIdentifierInformation <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-LinkedAccount <UserIdParameter>] [-Organization <OrganizationIdParameter>] [-WhatIf [<SwitchParameter>]]

This example creates the HRApp partner application and configures it to use an authorization server.

New-PartnerApplication HRApp -ApplicationIdentifier 00000006-0000-0dd1-ac00-000000000000 -Realm contoso.com -UseAuthServer $true

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.

 

Parameter Required Type Description

ApplicationIdentifier

Required

System.String

The ApplicationIdentifier parameter specifies a unique application identifier for the partner application that uses an authorization server. When specifying a value for the ApplicationIdentifier parameter, you must also use the UseAuthServer parameter.

AuthMetadataUrl

Required

System.String

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

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. When specifying the AuthMetadataUrl parameter for a partner application, you can't specify the ApplicationIdentifier and UseAuthServer parameters.

Name

Required

System.String

The Name parameter specifies a name for the partner application.

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.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

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 $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.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

Realm

Optional

System.String

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

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.

TrustAnySSLCertificate

Optional

System.Management.Automation.SwitchParameter

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

The TrustAnySSLCertificate switch specifies whether Exchange should trust certificates issued by a certification authority (CA) not trusted by the server.

CautionCaution:
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.

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.

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