.png)
New-SPSecureStoreServiceApplication
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Creates a new Secure Store Service application in the farm.
New-SPSecureStoreServiceApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> -AuditingEnabled <SwitchParameter> [-AssignmentCollection <SPAssignmentCollection>] [-AuditlogMaxSize <Nullable>] [-Confirm [<SwitchParameter>]] [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] [-Name <String>] [-PartitionMode <SwitchParameter>] [-Sharing <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| ApplicationPool | Required | Microsoft.SharePoint.Administration.SPIisWebServiceApplicationPool | Specifies the existing IIS application pool to run the Web service in for the new service application. | ||
| AuditingEnabled | Required | System.Management.Automation.SwitchParameter | Turns on auditing for the Secure Store Service. | ||
| Name | Required | System.String | Specifies the name of the new Secure Store Service application. | ||
| 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.
| ||
| AuditlogMaxSize | Optional | System.Nullable | Specifies the number of days to retain the audit log. The type must be a valid integer. | ||
| 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 authentication. | ||
| DatabaseName | Optional | System.String | Specifies the name of the Secure Store service database. | ||
| DatabasePassword | Optional | System.Security.SecureString | Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL authentication is used to access the metadata service application database. | ||
| DatabaseServer | Optional | System.String | Specifies the name of the host server for the database specified in DatabaseName. | ||
| DatabaseUsername | Optional | System.String | Specifies the user name to use for connecting to the database for the Secure Store service application. Use this parameter only if SQL authentication is used to access the service application database. | ||
| FailoverDatabaseServer | Optional | System.String | Specifies the name of the host server for the failover database server. | ||
| PartitionMode | Optional | System.Management.Automation.SwitchParameter | Specifies that the service application restricts data by subscription ID. This property cannot be changed after the service application is created. | ||
| Sharing | Optional | System.Management.Automation.SwitchParameter | Specifies that the Secure Store service application is published and shared across the farm. | ||
| 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 |
Note: Detailed Description
The New-SPSecureStoreServiceApplication cmdlet creates a new Secure Store Service application in the farm.
Input Types
Return Types
------------------EXAMPLE------------------
New-SPSecureStoreServiceApplication –ApplicationPool "SharePoint Web Services Default" –AuditingEnabled:$false –DatabaseServer "CONTOSO\SharePoint" –DatabaseName "ContosoSSDatabase"–Name "Contoso Secure Store"
This example creates a new Secure Store Service application with the name Contoso Secure Store with auditing disabled, and creates a database with the name ContosoSSDatabase on the given database server for use with the service application.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
