Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Set-SPAppAutoProvisionConnection

SharePoint 2013

Published: July 16, 2012

Applies to:  SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise 

Sets provision connection settings for an app.

Set-SPAppAutoProvisionConnection -ConnectionType <RemoteWebHost> -EndPoint <String> -Password <String> -Username <String> [-AssignmentCollection <SPAssignmentCollection>] [-SiteSubscription <SPSiteSubscriptionPipeBind>]
Set-SPAppAutoProvisionConnection -ConnectionType <RemoteWebHost> -EndPoint <String> [-AssignmentCollection <SPAssignmentCollection>] [-SiteSubscription <SPSiteSubscriptionPipeBind>]
Set-SPAppAutoProvisionConnection -ConnectionType <RemoteWebHost> -Password <String> -Username <String> [-AssignmentCollection <SPAssignmentCollection>] [-SiteSubscription <SPSiteSubscriptionPipeBind>]
Set-SPAppAutoProvisionConnection -Remove <SwitchParameter> [-AssignmentCollection <SPAssignmentCollection>] [-SiteSubscription <SPSiteSubscriptionPipeBind>]

Parameters

1

Parameter

Required

Type

Description

ConnectionType

Required

Microsoft.SharePoint.Administration.SPAppCmdlets.SetupAppAutoProvisionCmdlet+ConnectionTypes

Specifies the connection type to provision.

EndPoint

Required

System.String

Specifies the end point of the provision connection.

Password

Required

System.String

Specifies the password for the provision connection.

Username

Required

System.String

Specifies the user name of the connection.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

noteNote:

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.

SiteSubscription

Optional

Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind

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

2

Parameter

Required

Type

Description

ConnectionType

Required

Microsoft.SharePoint.Administration.SPAppCmdlets.SetupAppAutoProvisionCmdlet+ConnectionTypes

Specifies the connection type to provision.

EndPoint

Required

System.String

Specifies the end point of the provision connection.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

noteNote:

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.

SiteSubscription

Optional

Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind

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

3

Parameter

Required

Type

Description

ConnectionType

Required

Microsoft.SharePoint.Administration.SPAppCmdlets.SetupAppAutoProvisionCmdlet+ConnectionTypes

Specifies the connection type to provision.

Password

Required

System.String

Specifies the password for the provision connection.

Username

Required

System.String

Specifies the user name of the connection.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

noteNote:

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.

SiteSubscription

Optional

Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind

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

4

Parameter

Required

Type

Description

Remove

Required

System.Management.Automation.SwitchParameter

Removes the auto provision connection of the app.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

noteNote:

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.

SiteSubscription

Optional

Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind

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

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

Input Types

Return Types

------------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 http://SPremotewebhost.

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

$subscription = Get-SPSiteSubscription http://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 http://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.

Change History

Date Description

July 16, 2012

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.