Set-PartnerApplication

This cmdlet is available in on-premises Exchange 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 (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Set-PartnerApplication
   [-Identity] <PartnerApplicationIdParameter>
   [-AcceptSecurityIdentifierInformation <$true | $false>]
   [-ActAsPermissions <String[]>]
   [-ApplicationIdentifier <String>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Enabled <$true | $false>]
    [-LinkedAccount <UserIdParameter>]
   [-Name <String>]
   [-Realm <String>]
   [-WhatIf]
   [-AccountType <OrganizationalAccount | ConsumerAccount>]
   [<CommonParameters>]
Set-PartnerApplication
   [-Identity] <PartnerApplicationIdParameter>
   [-AcceptSecurityIdentifierInformation <$true | $false>]
   [-ActAsPermissions <String[]>]
   [-AuthMetadataUrl <String>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Enabled <$true | $false>]
    [-LinkedAccount <UserIdParameter>]
   [-Name <String>]
   [-TrustAnySSLCertificate]
   [-WhatIf]
   [-AccountType <OrganizationalAccount | ConsumerAccount>]
   [<CommonParameters>]
Set-PartnerApplication
   [-Identity] <PartnerApplicationIdParameter>
   [-AcceptSecurityIdentifierInformation <$true | $false>]
   [-ActAsPermissions <String[]>]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-Enabled <$true | $false>]
   [-LinkedAccount <UserIdParameter>]
   [-Name <String>]
   [-RefreshAuthMetadata]
   [-WhatIf]
   [-AccountType <OrganizationalAccount | ConsumerAccount>]
   [<CommonParameters>]

Description

You can configure partner applications such as SharePoint 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 Plan Exchange 2016 integration with SharePoint and Skype for Business (https://technet.microsoft.com/en-us/library/jj150480.aspx). 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 this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).

Examples

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

Set-PartnerApplication HRApp -RefreshAuthMetadata

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

Required Parameters

-Identity

The Identity parameter specifies the partner application you want to modify. You can use any value that uniquely identifies the partner application. For example:

  • Name

  • ApplicationID (GUID value)

  • Distinguished name (DN)

  • GUID

Type:PartnerApplicationIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016

Optional Parameters

-AcceptSecurityIdentifierInformation

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.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-AccountType

The AccountType parameter specifies the type of Microsoft account that's required for the partner application. Valid values are:

  • OrganizationalAccount: This is the default value

  • ConsumerAccount

Type:OrganizationalAccount | ConsumerAccount
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016
-ActAsPermissions

The ActAsPermissions parameter specifies the delegate permissions that are allowed for the partner application. You can specify multiple values separated by commas.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-ApplicationIdentifier

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-AuthMetadataUrl

This parameter is available only in on-premises Exchange.

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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-Confirm

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.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-DomainController

This parameter is available only in on-premises Exchange.

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.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-Enabled

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.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-LinkedAccount

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.

Type:UserIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-Name

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-Realm

This parameter is available only in on-premises Exchange.

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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-RefreshAuthMetadata

This parameter is available only in on-premises Exchange.

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-TrustAnySSLCertificate

This parameter is available only in on-premises Exchange.

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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-WhatIf

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.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.