Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Restart-SPAppInstanceJob

SharePoint 2013

Applies to:  SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard 

Restarts an app instance.

Restart-SPAppInstanceJob -AppInstance <SPAppInstance> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

AppInstance

Required

Microsoft.SharePoint.Administration.SPAppInstance

Specifies the app instance object to restart.

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.

noteNote:

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.

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

Use the Restart-SPAppInstanceJob cmdlet to restart an app instance.

Input Types

Return Types

-----------EXAMPLE-------------

$instance = Get-SPAppInstance -AppInstanceId $instance.Id
Restart-SPAppInstanceJob -AppInstance $instance

This example restarts an instance of an app by first returning the ID of the instance and then restarting it.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.