PnP.Powershell を使って SharePoint リストを作成する手順
今回は、PnP.Powershellを使って SharePoint リストを作成します。
材料（準備するもの）
- PowerShell または PowerShell ISE
- SharePoint サイト
- Microsoft 365 テナントの管理者アカウント
調理手順
- PnPPowershell をインストール
- SharePoint リストを作成するサイトへ接続
- SharePoint リストを作成
1. PnPPowershell をインストール
以下のコマンドを実行します。
特にエラーが出なければ、問題なくインストールができています。
Install-Module SharePointPnPPowershellOnline -Scope CurrentUser
補足
-Scope CurrentUser は管理者として実行するコマンドになります。
Microsoft Docs に掲載されている記事もありますので、参考にしてください。
PnP PowerShellモジュールのインストール
インストールが確認できているか確認するコマンドを実行してみましょう。
Get-Module SharePointPnPPowerShell* -ListAvailable | Select-Object Name,Version | Sort-Object Version -Descending
インストールができていれば以下のような表示が出ます。
表示が出なければ、インストールできておりませんので再度インストールしてください。
Name Version
---- -------
SharePointPnPPowerShellOnline 3.29.2101.0
2. SharePoint リストを作成するサイトへ接続
SharePoint サイトへ接続するために以下のコマンドを実行してください。
#tenant = テナント名
#sitename = サイトリンク
Connect-PnPOnline -Url https://<tenant>.sharepoint.com/sites/<sitename> -Credentials (Get-Credential)
補足
tenantとsitenameにはリストを作成するサイトのURLから入力してください。
Credentials (Get-Credential) は PowerShell 上でサインイン情報を確認されます。
Microsoft Authenticator などの多要素認証を利用している場合は、エラーが発生してしまいます。アカウント名とパスワードのみでは認証できないため、以下のコマンドを実行してみてください。
#tenant = テナント名
#sitename = サイトリンク
Connect-PnPOnline -Url https://<tenant>.sharepoint.com/sites/<sitename> -UseWebLogin
実行すると認証画面が出てくるので、認証情報を入力してください。
特にエラーが出なければ、問題なく接続できています。
3. SharePoint リストを作成
今回は、3つの方法でリストを作成していきます。
1. 新しいアナウンスリストを作成
以下のコマンドを実行してください。
#listtitle = 作成するリスト名
New-PnPList -Title <listtitle> -Template Announcements
サイトコレクションもしくはPowerShell ISE上で以下のコマンドを実行すると作成したリストを確認することができます。
Get-PnPList
補足
listtitleには作成するリスト名を入力してください。
-Titleは作成するリスト名を定義するコマンドになります。
-Templateは作成するリストのフォーマットを定義するコマンドになります。
今回はアナウンスリストのため、Announcementsですが、カスタムリストの場合はGenericListとなります。
パラメーターの種類は他にもございます。こちらのリンクを参考にしてください。
SharePoint リスト作成時のパラメーター
2. URLとは異なるタイトルのアナウンスリストを作成
以下のコマンドを実行してください。
#listtitle = 作成するリスト名
#listurl = 作成するリスト先のリンク名
New-PnPList -Title <listtitle> -Url "lists/<listurl>" -Template Announcements
サイトコレクションもしくは PowerShell で以下のコマンドを実行すると作成したリストを確認することができます。
Get-PnPList
補足
listtitleには作成するリスト名を入力してください。
listurlには作成するリスト作成のリンク名を入力してください。
-Titleは作成するリスト名を定義するコマンドになります。
-Urlは作成するリスト先のリンクを定義するコマンドになります。
-Templateは作成するリストのフォーマットを定義するコマンドになります。
リスト名をリンクは別名で定義することができるということですが、リスト名を日本語にする際にもよく使われます。
リストを作成する際に日本語のリスト名を作成すると、lists/ListsになってしまうのでURLを定義したい場合に利用してください。
今回はアナウンスリストのため、Announcementsですが、カスタムリストの場合はGenericListとなります。
パラメーターの種類は他にもございます。こちらのリンクを参考にしてください。
SharePoint リスト作成時のパラメーター
3. 新しいカスタムリストを作成し、SharePoint UIから非表示
以下のコマンドを実行してください。
#listtitle = 作成するリスト名
New-PnPList -Title <listtitle> -Template GenericList -Hidden
実行すると PowerShell で以下のコマンドを実行すると作成したリストを確認することができます。管理者権限を持っていてもサイトコレクションからリストを確認することはできません。
Get-PnPList
補足
listtitleには作成するリスト名を入力してください。
-Titleは作成するリスト名を定義するコマンドになります。
-Templateは作成するリストのフォーマットを定義するコマンドになります。
-Hiddenは作成するリストを表示させないコマンドになります。
今回はカスタムリストのため、GenericListですが、アナウンスリストの場合はAnnouncementsとなります。
パラメーターの種類は他にもございます。こちらのリンクを参考にしてください。
SharePoint リスト作成時のパラメーター
まとめ
今回はPnP.Powershellを利用してさまざまな種類の SharePoint リストを作成しました。PnPであればCUIとはいっても手が付きやすいモジュールだと思いますので、ぜひ活用してください。
こちらの記事が参考になったという方、いいねをお願いします。
また、こちらの記事についてご不明点・質問などございましたら、コメントからお願いします。
今回の記事の詳細は以下をご覧ください。
Discussion