Edit

Set-SPSecureStoreApplication

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

Sets properties of a Secure Store application.

Syntax

Set-SPSecureStoreApplication
   -Identity <SPSecureStoreApplication>
   [-Administrator <SPClaim[]>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-CredentialsOwnerGroup <SPClaim[]>]
   [-Fields <TargetApplicationField[]>]
   [-TargetApplication <TargetApplication>]
   [-TicketRedeemer <SPClaim[]>]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-SPSecureStoreApplication cmdlet sets properties of 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------------------

$targetApp.FriendlyName = "Updated Contoso Target App"
Set-SPSecureStoreApplication -Identity $application -TargetApplication $targetApp

This example sets a new display name Updated Contoso Target App for the target application.

Parameters

-Administrator

Specifies the administrator of the Secure Store application.

Type:SPClaim[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-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 Subscription Edition

-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-CredentialsOwnerGroup

Specifies the claims object for the groups that own the group credentials.

Type:SPClaim[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Fields

Specifies the field information for the application. The default fields are username and password.

Type:TargetApplicationField[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Identity

Specifies the Secure Store application to update.

Type:SPSecureStoreApplication
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-TargetApplication

Specifies the target application.

Type:TargetApplication
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-TicketRedeemer

Specifies the ticket redeemer claim value.

Type:SPClaim[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition