Get-SPAppInstance
Returns the metadata for an instance of an app.
Syntax
Get-SPAppInstance
-Identity <SPAppInstance>
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>] Get-SPAppInstance
-Site <SPSitePipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
-AppInstanceId <Guid>
[<CommonParameters>] Get-SPAppInstance
[-App <SPApp>]
[-AssignmentCollection <SPAssignmentCollection>]
-Web <SPWebPipeBind>
[<CommonParameters>] Description
This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.
Use the Get-AppInstance cmdlet to get a collection of app instances that are installed on an SPWeb object.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
-----------EXAMPLE 1-----------
Get-SPAppInstance -Web https://localhostThis example returns a collection if more than one app is installed on https://localhost. If only one app is installed, a single object is returned.
-----------EXAMPLE 2-----------
Get-SPAppInstance -AppInstanceId $instance.IdThis example returns the ID of an instance of an app.
Parameters
-App
Specifies the App.
This parameter returns metadata for all instances of an app.
| Type: | SPApp |
| 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 |
-AppInstanceId
Specifies the App Instance ID to display.
| Type: | Guid |
| 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 |
-Identity
Specifies the App instance for which to find metadata.
| Type: | SPAppInstance |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Site
Sets the query scope to a site.
Subsites are not included.
| Type: | SPSitePipeBind |
| 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 |
-Web
Specifies the SPWeb object.
| Type: | SPWebPipeBind |
| 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 |