Suspend-SPStateServiceDatabase
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise
Pauses a state database and thus prevents new rows of data from being added to a database.
Suspend-SPStateServiceDatabase [-Identity] <SPStateDatabasePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.Office.Server.Administration.SPStateDatabasePipeBind | Specifies the state database to pause. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a state database (for example, StateSvcDB1); or an instance of a valid SPStateServiceDatabase 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 | ||
| 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 Suspend-SPStateServiceDatabase cmdlet pauses a state database. This cmdlet updates the state database object that is specified in the Identity parameter.
Input Types
Return Types
--------------EXAMPLE-----------------
Suspend-SPStateServiceDatabase –Identity 9703f7e2-9521-47c3-bd92-80e3eeba391b
This example suspends a specified state service database.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: