Get-SPAppInstance

  • リファレンス
モジュール:
sharepoint-server
適用対象:
SharePoint Server Subscription Edition

アプリケーションのインスタンスのメタデータを返します。

構文

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>]

説明

このコマンドレットには、複数のパラメーター セットが含まれています。 使用できるのは、1 つのパラメーター セットのパラメーターだけであり、異なるパラメーター セットのパラメーターを組み合わせることはできません。 パラメーター セットの使用法に関する詳しい情報については、「コマンドレットのパラメーター セット」を参照してください。

Get-AppInstance コマンドレットは、SPWeb オブジェクトにインストールされているアプリケーション インスタンスのコレクションを取得します。

Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。

例

--------------- 例 1 --------------

Get-SPAppInstance -Web https://localhost

次の使用例は、複数のアプリがインストールされている場合にコレクションを返します https://localhost. アプリケーションが 1 つしかインストールされていない場合は、単一のオブジェクトが返されます。

--------------- 例 2 --------------

Get-SPAppInstance -AppInstanceId $instance.Id

この例では、アプリケーションのインスタンスの ID を取得します。

パラメーター

-App

アプリを指定します。

このパラメーターでは、アプリケーションのすべてインスタンスのメタデータが返されます。

Type:SPApp
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-AppInstanceId

表示するアプリ インスタンス ID を指定します。

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-AssignmentCollection

適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。

Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Identity

どのアプリケーション インスタンスのメタデータを探すかを指定します。

Type:SPAppInstance
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Site

クエリ範囲をサイトに設定します。

サブサイトは含められません。

Type:SPSitePipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Web

SPWeb オブジェクトを指定します。

Type:SPWebPipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition