Get-SPAppInstance
Returns the metadata for an instance of an app.
Syntax
IdentityParameterSet
Get-SPAppInstance
-Identity <SPAppInstance>
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
SiteAndIdParameterSet
Get-SPAppInstance
-Site <SPSitePipeBind>
-AppInstanceId <Guid>
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
WebParameterSet
Get-SPAppInstance
-Web <SPWebPipeBind>
[-App <SPApp>]
[-AssignmentCollection <SPAssignmentCollection>]
[<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://localhost
This 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.Id
This example returns the ID of an instance of an app.
Parameters
-App
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the App.
This parameter returns metadata for all instances of an app.
Parameter properties
| Type: | SPApp |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
WebParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AppInstanceId
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the App Instance ID to display.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SiteAndIdParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AssignmentCollection
Applicable: 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.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the App instance for which to find metadata.
Parameter properties
| Type: | SPAppInstance |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
IdentityParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Site
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Sets the query scope to a site.
Subsites are not included.
Parameter properties
| Type: | SPSitePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SiteAndIdParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Web
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the SPWeb object.
Parameter properties
| Type: | SPWebPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
WebParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.