Set-SPAppAutoProvisionConnection
Sets provision connection settings for an app.
Syntax
WebHostEndPoint
Set-SPAppAutoProvisionConnection
-ConnectionType <ConnectionTypes>
-EndPoint <String>
[-AssignmentCollection <SPAssignmentCollection>]
[-SiteSubscription <SPSiteSubscriptionPipeBind>]
[<CommonParameters>]
WebHostSetup
Set-SPAppAutoProvisionConnection
-ConnectionType <ConnectionTypes>
-EndPoint <String>
-Password <String>
-Username <String>
[-AssignmentCollection <SPAssignmentCollection>]
[-SiteSubscription <SPSiteSubscriptionPipeBind>]
[<CommonParameters>]
WebHostCredential
Set-SPAppAutoProvisionConnection
-ConnectionType <ConnectionTypes>
-Password <String>
-Username <String>
[-AssignmentCollection <SPAssignmentCollection>]
[-SiteSubscription <SPSiteSubscriptionPipeBind>]
[<CommonParameters>]
Remove
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
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ConnectionType
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the connection type to provision.
Parameter properties
| Type: | ConnectionTypes |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
WebHostEndPoint
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
WebHostSetup
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
WebHostCredential
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EndPoint
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the end point of the provision connection.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
WebHostEndPoint
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
WebHostSetup
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Password
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the password for the provision connection.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
WebHostSetup
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
WebHostCredential
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Remove
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Removes the auto provision connection of the app.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Remove
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SiteSubscription
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the site collection for which the provision connection is to be associated.
Parameter properties
| Type: | SPSiteSubscriptionPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Username
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the user name of the connection.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
WebHostSetup
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
WebHostCredential
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.