Set-SPAppAutoProvisionConnection

Module:

SharePointServer

Applies to:

SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Sets provision connection settings for an app.

Syntax

Set-SPAppAutoProvisionConnection
   -ConnectionType <ConnectionTypes>
   -EndPoint <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-SiteSubscription <SPSiteSubscriptionPipeBind>]
   [<CommonParameters>]

Set-SPAppAutoProvisionConnection
   -ConnectionType <ConnectionTypes>
   -EndPoint <String>
   -Password <String>
   -Username <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-SiteSubscription <SPSiteSubscriptionPipeBind>]
   [<CommonParameters>]

Set-SPAppAutoProvisionConnection
   -ConnectionType <ConnectionTypes>
   -Password <String>
   -Username <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-SiteSubscription <SPSiteSubscriptionPipeBind>]
   [<CommonParameters>]

Set-SPAppAutoProvisionConnection
   [-Remove]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-SiteSubscription <SPSiteSubscriptionPipeBind>]
   [<CommonParameters>]

Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.

Use the Set-SPAppAutoProvisionConnection cmdlet to set provision connection settings for a specified app.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

--------------------EXAMPLE 1---------------------

Set-SpAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https://SPremotewebhost -Password passname -Username <username>

This example configures remote web host to be used provision apps that use this functionality for the default site subscription server on https://SPremotewebhost.

--------------------EXAMPLE 2---------------------

C:\PS>$subscription = Get-SPSiteSubscription https://Contoso.com

Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https://SPremotewebhost -Password passname -Username <username> -SiteSubscription $subscription

This example configures remote web host to be used provision apps that use this functionality for the site subscription of Contoso.com site to server on https://SPremotewebhost.

--------------------EXAMPLE 3---------------------

Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -EndPoint https://SPremotewebhost

This example updates the endpoint of the already configured remote web host server https://SPRemotewebhost for the default site subscription.

--------------------EXAMPLE 4---------------------

Set-SPAppAutoProvisionConnection -ConnectionType RemoteWebHost -Remove

This example removes the remote web host configuration for the default site subscription.

Parameters

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ConnectionType

Specifies the connection type to provision.

Type:	ConnectionTypes
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-EndPoint

Specifies the end point of the provision connection.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Password

Specifies the password for the provision connection.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Remove

Removes the auto provision connection of the app.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SiteSubscription

Specifies the site collection for which the provision connection is to be associated.

Type:	SPSiteSubscriptionPipeBind
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Username

Specifies the user name of the connection.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Related Links

• Get-SPAppAutoProvisionConnection