Get-SPSecureStoreApplication

Reference

Module:: SharePointServer

Applies to:: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Returns a Secure Store application.

Syntax

Get-SPSecureStoreApplication
   -Name <String>
   -ServiceContext <SPServiceContextPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Get-SPSecureStoreApplication
   -ServiceContext <SPServiceContextPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-All]
   [<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.

The Get-SPSecureStoreApplication cmdlet returns a Secure Store application.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

------------------EXAMPLE 1------------------

$ssApp = Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApplication"

This example gets the Secure Store application for the target application with the name ContosoTargetApplication.

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

Get-SPSecureStoreApplication -ServiceContext http://contoso -All

This example returns all of the Secure Store applications http://contoso.

Parameters

-All

Returns all secure store applications for the given Service Context.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-AssignmentCollection

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.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Name

Specifies the name of the Secure Store application to get.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ServiceContext

Specifies the service context for the local Secure Store application to connect to.

Type:	SPServiceContextPipeBind
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Share via