Get-SPAppInstance
アプリケーションのインスタンスのメタデータを返します。
構文
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>]
説明
このコマンドレットには、複数のパラメーター セットが含まれています。 使用できるのは、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
該当: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
アプリを指定します。
このパラメーターでは、アプリケーションのすべてインスタンスのメタデータが返されます。
パラメーターのプロパティ
| 型: | SPApp |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
WebParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AppInstanceId
該当: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
表示するアプリ インスタンス ID を指定します。
パラメーターのプロパティ
| 型: | Guid |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
SiteAndIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AssignmentCollection
該当: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。
Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。
パラメーターのプロパティ
| 型: | SPAssignmentCollection |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
該当: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
どのアプリケーション インスタンスのメタデータを探すかを指定します。
パラメーターのプロパティ
| 型: | SPAppInstance |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
IdentityParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Site
該当: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
クエリ範囲をサイトに設定します。
サブサイトは含められません。
パラメーターのプロパティ
| 型: | SPSitePipeBind |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
SiteAndIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Web
該当: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
SPWeb オブジェクトを指定します。
パラメーターのプロパティ
| 型: | SPWebPipeBind |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
WebParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。