Set-SPStateServiceApplication
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise
Updates the name of a state service application.
Set-SPStateServiceApplication [-Identity] <SPStateServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Name <String>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.Office.Server.Administration.SPStateServiceApplicationPipeBind | Specifies the state service application to update. The type must be a valid name of a state service application (for example, StateServiceApp1); a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPStateServiceApplication 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 | ||
| Name | Optional | System.String | Specifies the display name of the state service application. The type must be a valid name of a state service application; for example, StateSvc1. | ||
| 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
The Set-SPStateServiceApplication cmdlet updates the name of a state service application.
Input Types
Return Types
--------------EXAMPLE-----------------
Set-SPStateServiceApplication -Identity "State Service Application 1" –Name "New name for State Service Application 1"
This example changes the display name of a state service application.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: