SharePoint アドイン モデルにおける Feature Stapling

重要

SharePoint アドインは、2026 年 4 月 2 日に SharePoint Online のサポートが終了しました。 SharePoint でホストされているアドインとプロバイダーでホストされているアドインはどちらも廃止され、政府機関向けクラウドを含む SharePoint Online では機能しなくなります。 アドインの開発、展開、使用に関するガイダンスは、新しい SharePoint Online ソリューション用ではなく、履歴参照と該当する SharePoint Server シナリオ用に保持されます。

オンプレミスのアプリ カタログを通じて展開された SharePoint Server アドインは、この変更によって廃止されません。 パブリック マーケットプレースからの SharePoint アドインの取得は、SharePoint Server の 2026 年 4 月 2 日に終了しました。

この廃止により、SharePoint REST API、CSOM、JSOM、または SharePoint Framework (SPFx) は廃止されません。 SharePoint Online の場合は、ユーザー インターフェイス拡張機能に SPFx を使用し、外部アプリケーションへの認証に Microsoft Entra ID を使用します。 廃止のお知らせとアドインの移行ガイダンスを参照してください。

新しい SharePoint アドイン モデルにおいて、SharePoint サイトがプロビジョニングされているときにコードの実行や成果物の展開に使用するアプローチは、完全信頼コードの場合とは異なります。 一般的な完全信頼コード (FTC) / ファーム ソリューション シナリオでは、機能の関連付けによって標準のサイト定義を変更していました。 SharePoint サイトに関連する成果物、構成、およびブランド化資産は機能によってパッケージ化および展開され、機能はサイト定義に関連付けられました。 その後、関連付けられた機能はサイト プロビジョニングによって自動的にインストールされ、アクティブ化されました。

SharePoint アドイン モデル シナリオでは、機能の関連付け、アドインの関連付け、または SharePoint クライアント側オブジェクト モデル (CSOM) を使用して、サイト コレクションとサブサイトを作成および構成した後、成果物、構成、およびブランド化資産をそこに展開することができます。 このパターンは、一般的にリモート プロビジョニング パターンと呼ばれます。

基本ガイドライン

サイト コレクションとサブサイトを作成および構成した後、成果物、構成、およびブランド化資産をそこに展開する方法については、経験に基づく次のような大まかなガイドラインが提供されています。

  • 機能の関連付けを引き続き使用する唯一の方法は、機能をサイト コレクションに関連付け、サイト定義および関連付けられた機能をサンドボックス ソリューションによって展開することです。
  • テナント展開型モデルで機能の関連付けに似た機能を実装するには、アドインの関連付けを使用できます。
  • リモート プロビジョニング パターンを使用して機能の関連付けに似た機能を実装するには、リモート API によって標準のサイト定義上で追加の機能をアクティブ化します。

サイト コレクションとサブサイトを作成および構成した後、成果物、構成、およびブランド化資産をそこに展開するためのオプション

サイト コレクションとサブサイトを作成および構成した後、成果物、構成、およびブランド化資産をそこに展開するためのオプションは複数あります。

  • 機能を関連付ける
  • アドインを関連付ける
  • リモート プロビジョニング パターンを使用する

機能を関連付ける

このパターンでは、機能をサイト定義に関連付けます。

  • このパターンは、サイト コレクション レベルでのみ行うことができます。
  • 機能をサブサイトに関連付けることはできません。
  • 廃止されたサンド ボックス ソリューションが使用され、アップグレードに対応できないため、これは推奨される最適なアプローチではありません。

適切な場合

オンプレミス SharePoint 環境でレガシー コードを移行しており、コードを適切に書き直す時間がない場合。

はじめに

次の記事では、サイト定義に機能を関連付ける方法について説明しています。

アドインを関連付ける

このパターンでは、アプリ カタログに保存されているアドインを、特定のサイト コレクション、管理パス、サイト テンプレートに展開します。

  • アドインの関連付けモデルの詳細については、「"アプリの関連付け" による SharePoint 2013 アプリの展開 (MSDN ブログ記事 - Richard DiZerega)」を参照してください。
  • アドインは管理者によってプッシュされるため、サイト所有者は展開の基準を満たすサイトからアドインを削除することはできません。 サイト コレクション管理者であっても、アドインを削除することはできません。
  • この一元的な展開では、同じ一元的なアドイン リソース (アドイン Web とリモート Web) も共有されます。 基本的に、アドインは展開されますが、サイトにはインストールされません。 すべてのサイトで、アプリ カタログにインストールされたインスタンスからアドイン Web とリモート Web が利用されます。
  • 一元的な展開のため、HandleAppInstalled、HandleAppUninstalled、HandleAppUpgrade などのリモート イベントは、1 回のみ (アドインがアプリ カタログにインストールされる際に) 起動されます。
    • アドインの関連付けパターンを使用して変更をアドインの展開先のサイトに自動的に適用することは、サイトへのアドインの展開時にこれらのイベントが起動されないため、難しくなる可能性があります。
  • アドインがサイトに関連付けられている場合、アドイン パーツはサポートされません。
  • このパターンでは、ユーザーの手動アクションによってアドインを配置する必要があります。

リモート プロビジョニング パターンを使用する

このパターンでは、SharePoint クライアント側オブジェクト モデル (CSOM) を使用して、サイト コレクションとサブサイトを作成および構成した後、成果物、構成、およびブランド化資産をそこに展開します。

  • このパターンでは、個別の機能またはアドインにアーティファクト、構成、ブランディング アセットをパッケージ化する必要はありません。すべてを 1 つのアドインにパッケージ化できます。

  • このパターンをサイト プロビジョニングに使用する場合、通常は標準のページをオーバーライドして新しいサイトを作成します。

  • このパターンの詳細については、「サイト プロビジョニング (SharePoint アドイン レシピ)」を参照してください。

  • アドインを SharePoint サイトに配置するには、CSOM を使用することができます。 .app マニフェスト ファイルを使用して Office アドインを読み込んで SharePoint サイトにインストールする例を以下に示します。

    //Create a FileStream object to access the Mail Office Add-in .app file
    using (FileStream fsSource = new FileStream(System.Web.Hosting.HostingEnvironment.ApplicationPhysicalPath + "Innovation.Management.AFO.app",
      FileMode.Open, FileAccess.Read))
      {
    //Return the subweb where you want to install the Add-in
          var subweb = ctx.Web;
          ctx.Load(subweb);
          ctx.ExecuteQuery();
    
    //Load and Install the Add-in on the subweb
          AppInstance appInstance = subweb.LoadAndInstallApp(fsSource);
          ctx.Load(appInstance);
          ctx.ExecuteQuery();
      }
    

PnP サンプル

適用対象

  • Office 365 マルチテナント (MT)
  • Office 365 専用 (D)
  • SharePoint 2013 オンプレミス