SharePoint サイトテンプレートとサイトスクリプトの概要

[アーティクル]
04/08/2023

注:

サイトテンプレートとサイトスクリプトは、現在、SharePoint Online でのみサポートされています。
以前のバージョンの SharePoint ではサイトテンプレートはサイトデザインと呼ばれていましたが、今後はサイトテンプレートと呼ばれます。
SharePoint には、サイトの作成を許可されたすべての SharePoint ユーザーが利用できる新しいサイトテンプレートエクスペリエンスがあります。新しいサイトテンプレートエクスペリエンスの詳細をご覧ください。
現在、サイトテンプレートエクスペリエンスを無効にすることはできません。
組織によって作成され、既定のテンプレートとして設定されたサイトテンプレートは、新しいサイトが作成されたときに自動的に適用されますが、サイト所有者は [設定]、[サイトテンプレートの適用] の順に選択して更新できます。
サイトテンプレートのバージョン履歴は現在、新しいサイトテンプレートエクスペリエンスでは利用できませんが、将来のイテレーションに含まれる予定です。

サイトテンプレートとサイトスクリプトを使用し、独自のカスタム構成を使用して新規または既存のモダン SharePoint サイトのプロビジョニングを自動化します。

組織内の人員が新しい SharePoint サイトを作成する場合、一定のレベルの一貫性を確保しなければならない場合があります。たとえば、新しいサイトごとに適切なブランドとテーマを適用する必要があります。 PnP プロビジョニングエンジンの使用など、新しいサイトが作成されるたびに適用する必要がある、詳細なサイトプロビジョニングスクリプトを作成することもできます。

この記事では、サイトテンプレートとサイトスクリプトを使用して、新しいサイトを作成したときに適用するカスタム構成を提供する方法について説明します。

サイトテンプレートのしくみ

新しいサイトを作成するたびにサイトテンプレートを使用して、一貫性のある一連のアクションを適用することができます。また、既存のモダンサイト (グループに接続されたチームおよびコミュニケーションサイト) に適用することもできます。通常、ほとんどのアクションは、テーマの設定やリストの作成など、そのサイト自体に影響します。しかし、サイトテンプレートには、新しいサイトの URL をログに記録したり、ツイートを送信したりするなど、他のアクションを含めることもできます。

注:

カスタムサイトスクリプトを使用して作成されたサイトテンプレートは、サイトテンプレートギャラリーの [組織から] タブに表示されます。
組織で作成されたカスタムサイトテンプレートは、ユーザーが選択したサイトの種類 (コミュニケーションサイトまたはチームサイト) に基づいてサイトテンプレートギャラリーに表示されます。そのため、サイトテンプレートギャラリーに組織のすべてのサイトテンプレートが表示されない可能性があります。近日中に、選択したサイトの種類にかかわらず、ユーザーは組織が提供するすべてのサイトテンプレートを閲覧できるようになります。

サイトテンプレートを作成し、SharePoint でそれらをモダンテンプレートサイトの 1 つ、つまりチームサイトまたはコミュニケーションサイトに登録します。次の手順で、このしくみを確認できます。

開発者テナントで SharePoint の開始ページに進みます。
[サイトの作成] を選択します。

2 つのモダンテンプレートサイトであるチームサイトとコミュニケーションサイトが表示されます。
必要なサイトの種類を選択します。
- SharePoint で トピック サイトテンプレートを使用して通信サイトが自動的に作成されます。
- 既定のチームサイトを選択した場合、SharePoint では チームコラボレーション テンプレートを使用して新しいサイトが作成されます。
既定のサイトテンプレートの変更方法の詳細については、「既定のサイトテンプレートのカスタマイズ」を参照してください。
[設定] アイコンに移動し、[サイトテンプレートの適用] を選択して、手順 3 で選択したサイトの種類に基づいて Microsoft が提供するサイトテンプレートを確認します。

サイトテンプレートを選択すると、SharePoint は新しいサイトを作成し、サイトテンプレートのサイトスクリプトを実行します。サイトスクリプトでは、新しいリストの作成やテーマの適用など、テンプレートの詳細を指定します。これらのスクリプトアクションは、バックグラウンドで実行されます。スクリプトが完了すると、ページが更新し、サイトスクリプトの詳細が表示されます。

注:

サイトテンプレートは、以前に作成したモダンサイトコレクションに適用できるようになりました。詳細については、「REST API」と「PowerShell」の記事を参照してください。

サイトスクリプトの構造

サイトスクリプトは、新しいサイトを作成するときに実行するアクションの番号付きリストを指定した JSON ファイルです。アクションは、リストされている順序で実行されます。

最上位レベルの 2 つのアクションを含むスクリプトの例を以下に示します。最初に、「Contoso Explorers」という名前で以前に作成されたテーマを適用します。次に、顧客追跡リストを作成します。

{
  "$schema": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json",
  "actions": [
    {
      "verb": "applyTheme",
      "themeName": "Contoso Explorers"
    },
    {
      "verb": "createSPList",
      "listName": "Customer Tracking",
      "templateType": 100,
      "subactions": [
        {
          "verb": "setDescription",
          "description": "List of Customers and Orders"
        },
        {
          "verb": "addSPField",
          "fieldType": "Text",
          "displayName": "Customer Name",
          "isRequired": false,
          "addToDefaultView": true
        },
        {
          "verb": "addSPField",
          "fieldType": "Number",
          "displayName": "Requisition Total",
          "addToDefaultView": true,
          "isRequired": true
        },
        {
          "verb": "addSPField",
           "fieldType": "User",
          "displayName": "Contact",
          "addToDefaultView": true,
          "isRequired": true
        },
        {
          "verb": "addSPField",
          "fieldType": "Note",
          "displayName": "Meeting Notes",
          "isRequired": false
        }
      ]
    }
  ],
  "version": 1
}

サイトスクリプトの各アクションは、JSON で動詞の値で指定されます。前述のスクリプトでは、最初のアクションは applyTheme 動詞で指定されます。次に、createSPList 動詞でリストを作成します。 createSPList 動詞には、リストだけに追加のアクションを実行する独自の動詞セットが含まれています。

使用可能なアクションは次のとおりです:

新しいリストまたはライブラリの作成 (またはサイトで作成された既定の変更)
サイト列の作成、コンテンツタイプ、およびその他のリスト設定の構成
ナビゲーションレイアウト、ヘッダーレイアウト、ヘッダーの背景などのサイトのブランドのプロパティを設定する
テーマの適用**
サイトロゴの設定
クイック起動またはハブナビゲーションにリンクを追加する**
Power Automate フローのトリガー
アプリカタログから展開されたソリューションのインストール
サイトの地域設定の設定**
SharePoint の役割にプリンシパル (ユーザーとグループ) を追加する**
サイトの外部の共有機能の設定**

使用可能なアクションとそのパラメーターの完全な一覧については、「JSON スキーマ」を参照してください。

注:

** でマークされたアクションは、チャネルサイトに対して自動的にブロックされます。
ライブラリおよびリストの場合は、PowerShell コマンド [Get-SPOSiteScriptFromList] を使用して、既存の SharePoint リストからサイトスクリプト構文を作成します。

サイトスクリプトは、プロビジョニング後に同じサイトで再度実行できます。サイトスクリプトは破壊的ではないため、再度実行された場合でも、サイトはスクリプト内の設定と一致することが保証されます。

たとえば、サイトスクリプトが作成しているのと同じ名前のリストがサイトに既に存在する場合、サイトスクリプトは不足しているフィールドのみを既存のリストに追加します。

サイトスクリプトアクションの数の上限は以前に 30 に制限されました。これは Invoke-SPOSiteDesign コマンドを使用して同期的に適用されるスクリプトの制限のままですが、顧客からのフィードバックと追加のアクションのサポートに基づいて、スクリプトが非同期的に適用される (UI または Add-SPOSiteDesignTask コマンドを使用する) 場合、この制限は 300 アクション (または 100,000 文字) に達しました。

また、サイトスクリプト数の上限は 100、1 テナントあたりのサイトテンプレート数の上限は 100 に制限されています。

PowerShell または REST を使用したサイトテンプレートとサイトスクリプトの操作

PowerShell または REST API を使用して、サイトテンプレートとサイトスクリプトを作成できます。次の例では、サイトスクリプトと、サイトスクリプトを使用するサイトテンプレートを作成します。

C:\> Get-Content 'c:\scripts\site-script.json' `
     -Raw | `
     Add-SPOSiteScript `
    -Title "Contoso theme and list"

Id          : 2756067f-d818-4933-a514-2a2b2c50fb06
Title       : Contoso theme and list
Description :
Content     :
Version     : 0

C:\> Add-SPOSiteDesign `
  -Title "Contoso customer tracking" `
  -WebTemplate "64" `
  -SiteScripts "2756067f-d818-4933-a514-2a2b2c50fb06" `
  -Description "Creates customer list and applies standard theme"

前の例では、 Add-SPOSiteScript コマンドレットまたは CreateSiteScript REST API によってサイトスクリプト ID が返されます。これは、Add-SPOSiteDesign コマンドレットまたは CreateSiteDesign REST API の後続の呼び出しで SiteScripts パラメーターに使用されます。

パラメーター	値	サイトテンプレートの種類
WebTemplate	64	チームサイトテンプレート
WebTemplate 1	1	チームサイト (グループの作成は無効)
WebTemplate	68	コミュニケーションサイトのテンプレート
WebTemplate	69	チャネルサイトテンプレート

サイトテンプレートを作成する一つ一つの手順の内容については、「サイトテンプレートの作成を開始する」を参照してください。

注:

サイトテンプレートは複数のスクリプトを実行できます。スクリプト ID が配列に渡され、リストされている順序で実行されます。
サイトテンプレートの以前の用語は、特定のコマンドレットラベルとスクリプトラベルに "サイトデザイン" として表示される場合があります。

Power Automate を使用した PnP プロビジョニングおよびカスタマイズ

サイトスクリプトによって提供される 1 つのアクションは、Power Automate フローをトリガーする機能です。これにより、サイトスクリプトでネイティブに提供されるアクション以外に、必要なカスタムアクションを指定することができます。

PnP プロビジョニングエンジンを使用してサイト作成を自動化する場合は、Power Automate フローを使用してサイトテンプレートと統合できます。この手法を使用して、既存のプロビジョニングスクリプトをすべて維持しながら、新しいカスタムプロビジョニングスクリプトを作成することができます。

Microsoft Flow のトリガープロセス

プロセスは次のように動作します。

このスクリプトは、URL を使用して Power Automate フローを追加の詳細とともにインスタンス化します。
このフローは、ユーザーが構成した Azure ストレージキューにメッセージを送信します。
このメッセージは、ユーザーが構成した Azure 関数の呼び出しをトリガーします。
Azure 関数は、PnP プロビジョニングエンジンなどのカスタムスクリプトを実行して、カスタム構成を適用します。

PnP プロビジョニングを使用して独自の Power Automate フローを構成する方法のステップごとのチュートリアルについては、「PnP プロビジョニングエンジンを使用して完全なサイトテンプレートを作成する」を参照してください。

スコープ

組織内の特定のグループまたは人員にのみ表示するサイトテンプレートを構成できます。これにより、対象となる人々だけがそのサイトテンプレートを見ることができるようになります。たとえば、会計部門には、会計部門用の特別なサイトテンプレートのみを表示することができます。会計部門以外の人にとって、会計のサイトテンプレートは重要度が低い可能性があります。

既定では、作成時にすべてのユーザーがそのサイトテンプレートを表示できます。スコープは、Grant-SPOSiteDesignRights コマンドレットまたは GrantSiteDesignRights REST API を使用して適用されます。ユーザーごとに、またはメールが有効なセキュリティグループで、スコープを指定することができます。

Nestor (架空の Contoso サイトに所属するユーザー) のサイトテンプレートに対する表示権限を追加する方法の例を次に示します。

Grant-SPOSiteDesignRights `
  -Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 `
  -Principals "nestorw@onmicrosoft.com" `
  -Rights View

スコープの処理方法の詳細については、「サイトテンプレートへのアクセスのスコープ」を参照してください。

SharePoint サイトテンプレートとサイトスクリプトの概要

サイトテンプレートのしくみ

サイトスクリプトの構造

PowerShell または REST を使用したサイトテンプレートとサイトスクリプトの操作

Power Automate を使用した PnP プロビジョニングおよびカスタマイズ

スコープ

関連項目

その他のリソース

SharePoint サイト テンプレートとサイト スクリプトの概要

サイト テンプレートのしくみ

サイト スクリプトの構造

PowerShell または REST を使用したサイト テンプレートとサイト スクリプトの操作

Power Automate を使用した PnP プロビジョニングおよびカスタマイズ

スコープ

関連項目

その他のリソース

SharePoint サイトテンプレートとサイトスクリプトの概要

サイトテンプレートのしくみ

サイトスクリプトの構造

PowerShell または REST を使用したサイトテンプレートとサイトスクリプトの操作