.png)
New-SPSecureStoreServiceApplicationProxy
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Creates a new Secure Store Service application proxy in the farm.
New-SPSecureStoreServiceApplicationProxy -Uri <Uri> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DefaultProxyGroup <SwitchParameter>] [-Name <String>] [-WhatIf [<SwitchParameter>]]
New-SPSecureStoreServiceApplicationProxy -ServiceApplication <SPServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DefaultProxyGroup <SwitchParameter>] [-Name <String>] [-WhatIf [<SwitchParameter>]]
Parameters
1| Parameter | Required | Type | Description | ||
| Uri | Required | System.Uri | Specifies the URI of a remote Secure Store Service application associated with the new proxy. The type must be a valid URI, in the form file:\\server_name\sitedocs. | ||
| 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 | ||
| DefaultProxyGroup | Optional | System.Management.Automation.SwitchParameter | Specifies that the service application proxy be added to the farm’s default proxy group. | ||
| Name | Optional | System.String | Specifies the name of the new service application proxy to create. | ||
| 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: | Parameter | Required | Type | Description | ||
| ServiceApplication | Required | Microsoft.SharePoint.PowerShell.SPServiceApplicationPipeBind | Specifies the local Secure Store Service application associated with the new proxy. | ||
| 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 | ||
| DefaultProxyGroup | Optional | System.Management.Automation.SwitchParameter | Specifies that the service application proxy be added to the farm’s default proxy group. | ||
| Name | Optional | System.String | Specifies the name of the new service application proxy to create. | ||
| 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
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.
The New-SPSecureStoreServiceApplicationProxy cmdlet creates a new Secure Store Service application proxy for a Secure Store Service application in the farm.
The New-SPSecureStoreServiceApplicationProxy cmdlet does not specify whether the service application proxy is partitioned or not. If you want to specify a partitioned service application proxy, a partitioned service application can be created by using the New-SPSecureStoreServiceApplication cmdlet. The result of the New-SPSecureStoreServiceApplication cmdlet can be passed to the New-SPSecureStoreServiceApplicationProxy cmdlet. Similarly, if you want to specify an unpartitioned service application proxy, an unpartitioned service application can be created by using the New-SPSecureStoreServiceApplication cmdlet. The result of the New-SPSecureStoreServiceApplication cmdlet can be passed to the New-SPSecureStoreServiceApplicationProxy cmdlet.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
| Exceptions | Description |
|---|---|
------------------EXAMPLE 1------------------
New-SPSecureStoreServiceApplicationProxy –Name "Contoso Service Application Proxy" –ServiceApplication $SSServiceApp
This example creates a new Secure Store Service application proxy with the name Contoso Service Application Proxy for the given service application.
------------------EXAMPLE 2------------------
$nameofproxy = "Connection to: HostedSecureStoreInParentFarm"
$proxy = Get-SPServiceApplicationProxy | where {$_ -match $nameofproxy}
$prop = $proxy.Properties
$type = $prop["Microsoft.Office.Server.Utilities.SPPartitionOptions"].GetType()
$partition = [enum]::Parse( $type, 1 )
$prop["Microsoft.Office.Server.Utilities.SPPartitionOptions"] = $partition
$proxy.Update()
This example converts an unpartitioned secure store service application proxy in the child to a partitioned one.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
