New-SPSubscriptionSettingsServiceApplication
Published: May 12, 2010
Creates a new subscription settings service application.
New-SPSubscriptionSettingsServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] [-DatabaseServer <String>] [-FailoverDatabaseServer <String>] [-Name <String>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
ApplicationPool |
Required |
Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind |
Specifies the IIS application pool to use for the new subscription settings application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object. |
||
|
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.
|
||
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters |
||
|
DatabaseCredentials |
Optional |
System.Management.Automation.PSCredential |
Specifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication. The type must be a valid PSCredential object. |
||
|
DatabaseName |
Optional |
System.String |
Specifies the name of the subscription settings database. If not provided, one will be generated. The type must be a valid name of a SQL Server database; for example, SubscriptionSettingsApp1. |
||
|
DatabaseServer |
Optional |
Microsoft.SharePoint.PowerShell.SPServerPipeBind |
Specifies the name of the host SQL Server instance for the database specified in the DatabaseName parameter. If not provided, the default database server will be used The type must be a valid SQL Server instance name; for example, SQLServerHost1. The type must be a valid name of a SQL Server database; for example, SubscriptionSettingsApp1. |
||
|
FailoverDatabaseServer |
Optional |
Microsoft.SharePoint.PowerShell.SPServerPipeBind |
Specifies the name of the host SQL Server instance for the failover database server. The type must be a valid SQL Server instance name; for example, SQLServerHost1. |
||
|
Name |
Optional |
System.String |
Specifies the friendly name of the new subscription settings service. The type must be a valid name of a subscription settings service application; for example, SubscriptionSettingsApp1. |
||
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Detailed Description
Use the New-SPSubscriptionSettingsServiceApplication cmdlet to create a subscription settings service application that can be used to store settings that are shared across all site collections in a single site subscription. This cmdlet is used only in an environment where site subscriptions are used to delegate administration or partition services that are used for storing settings that are shared across all site collections in a single site subscription. This cmdlet is used only in an environment where site subscriptions are used to delegate administration or partition services.
Input Types
Return Types
-------------EXAMPLE---------------
$AppPool = New-SPServiceApplicationPool -Name SettingsServiceAppPool -Account (Get-SPManagedAccount DOMAIN\jdoe)
$App = New-SPSubscriptionSettingsServiceApplication -ApplicationPool $appPool –Name SettingsServiceApp –DatabaseName SettingsServiceDB
$proxy = New-SPSubscriptionSettingsServiceApplicationProxy -ServiceApplication $App
Get-SPServiceInstance | where{$_.TypeName -eq "Microsoft SharePoint Foundation Subscription Settings Service"} | Start-SPServiceInstance
This example creates an application pool, a new subscription settings service application, a subscription settings service application proxy, and starts the service instance on the local machine. This example assumes that a managed account for DOMAIN\jdoe already exists.
Change History
| Date | Description | Reason |
|---|---|---|
|
May 12, 2010 |
Initial publication |
|

Note: