Restart-SPAppInstanceJob

Reference

Module:: SharePointServer

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

Restarts an app instance.

Syntax

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

Description

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

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715).

Examples

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

$instance = Get-SPAppInstance -Web https://site_url | ?{$_.Title -eq 'Contoso App'}
Restart-SPAppInstanceJob -AppInstance $instance

Restarts the App Instance for the App named 'Contoso App' on https://site_url.

Parameters

-AppInstance

Specifies the app instance object to restart.

Type:	SPAppInstance
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	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 2013, SharePoint Server 2016, SharePoint Server 2019

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object

Share via