| external help file | Microsoft.SharePoint.PowerShell.dll-help.xml |
|---|---|
| Module Name | Microsoft.SharePoint.Powershell |
| online version | https://learn.microsoft.com/powershell/module/microsoft.sharepoint.powershell/restart-spappinstancejob |
| applicable | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
| title | Restart-SPAppInstanceJob |
| schema | 2.0.0 |
| author | techwriter40 |
| ms.author | pamgreen |
| ms.reviewer |
Restarts an app instance.
Restart-SPAppInstanceJob -AppInstance <SPAppInstance> [-AssignmentCollection <SPAssignmentCollection>]
[-Confirm] [-WhatIf] [<CommonParameters>]
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.
$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.
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the app instance object to restart.
Type: SPAppInstance
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseApplicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).