スタッフブログ

PnP.PowerShell の Set-PnPPage コマンドについて


こんにちは、T.S.です。
今回は SharePoint に関しての記事になります。

ページ作成時の画像

SharePoint サイト内でページを作成すると、以下のように画像領域がデフォルトで用意されています。

現在は通常の Web パーツを削除する手順同様、 UI 上で編集ボタンからこちらの画像領域を削除できるようになっておりますが(いつの間に、、、)つい最近までは UI 上で削除することは不可能でした。
UI 上から画像領域を削除することも可能ですが、 PowerShell でも削除コマンドは存在していたためそちらをご紹介させていただきます。

Set-PnPPageコマンド

Set-PnPPage -Identity “<ページ名>” -LayoutType Home

上記コマンドを実行することで、ページ内の他のWebパーツを残したまま画像領域のみを取り除くことができます。
ただし、このコマンドは PowerShell 7 のみで動作します。

まずは以下のコマンドを実行して SharePoint サイトへ接続してください。

Connect-PnPOnline -Url “<サイトURL>”

認証情報を聞かれますので適宜入力してください。

(※コマンド実行)

(※設定前)

(※設定後)

最後に

今回は Set-PnPPage コマンドを実行して画像領域を削除する手順についてご紹介しました。
正直 UI 上で処理できるようになっているので、画像領域を削除するコマンド自体は今後使用する機会は少ないとは思います。
パラメータとして “-LayoutType Home” を渡してあげることで画像領域の削除を実行でき、 LayoutType の値自体は Home 含めて7つほどあるようなので、別の値について検証してまたの機会にでもお伝えできればと思います。

最後までご覧いただきありがとうございました。