M365Con 2027 – 無料オンラインカンファレンス · 11–22 Jan 2027 · 120 sessions→ m365con.net

ブログ · Mirko Peters

PnP PowerShellでSharePoint Onlineに接続する: サインインの方法

By · · Updated

PnP PowerShellでSharePoint Onlineに接続する方法です。まず自分のEntraアプリを登録し、作業ごとに対話型、デバイス、証明書、マネージドIDのいずれかでサインインしてください。

Automatically translated with AI from the original post. Read the English original

現在PnP PowerShellでSharePoint Onlineに接続するには、まずMicrosoft Entra IDで自分のアプリを一度登録します。その後、サイトURLとそのアプリのクライアントIDを指定してConnect-PnPOnlineを呼び出し、対話型、デバイスログイン、証明書、マネージドID、従来の資格情報のいずれか1つのサインイン方法を指定します。本ガイドは、スクリプトを手動で実行する場合やスケジュールで実行する場合のSharePoint管理者を対象としています。各方法の動作、使用すべき場面、接続を失敗させる典型的なミスを解説します。また、スクリプトが作業に必要以上のアクセス権を持たないよう、作業ごとに方法を1つ選ぶ考え方も紹介します。

重要なポイント

  • 2024年9月9日以降、Connect-PnPOnlineには-ClientIdが必要です。そのため、すべての管理者は、モジュールがサインインに使用できるアプリをMicrosoft Entra IDで事前に登録しておく必要があります。
  • 対話型サインインは、キーボードの前にいる人が操作する場合に適しています。多要素認証に対応しており、保存されたシークレットも不要です。
  • 無人で実行するジョブには、入力したパスワードや、スクリプトに保存したクライアントシークレットではなく、証明書サインインまたはマネージドIDを使用してください。
  • 従来のクライアントシークレット方式はSharePointのコマンドレットでのみ動作します。そのため、Microsoft Graphを呼び出すコマンドはこの方式では失敗します。
  • 必要な委任されたアクセス許可だけを指定してアプリを登録してください。既定の登録では AllSites.FullControl のような広範な権限が要求されるためです。

はじめに: 接続ごとに自分のアプリが必要な理由

PnP PowerShellはコミュニティによって保守されているモジュールです。モジュール自体が特別な権限を持つことはありません。サインインはすべてMicrosoft Entraのアプリ登録を経由し、そのアプリがスクリプトに許可される操作を決定します。

Connect-PnPOnlineのリファレンスには、2024年9月9日以降、-ClientIdパラメーターの指定が必要になると記載されています。また、先に自分のアプリを登録する必要があるとも記載されています。毎回IDを入力する代わりに、ENTRAID_APP_IDまたはENTRAID_CLIENT_ID環境変数を設定することもできます。

この変更により、以前のスクリプトに影響が出ています。2023年に作成したスクリプトがConnect-PnPOnline -Url ... -Interactiveのみを呼び出している場合、現在は失敗するか、不足しているクライアントIDの入力を求めるプロンプトが表示されます。解決策はスクリプトのロジックを変更することではありません。アプリを用意し、そのIDを指定する必要があります。

すべての例に登場する値がほかに2つあります。

  • -Urlは、操作対象とするサイトのアドレスです(例: https://contoso.sharepoint.com/sites/finance)。ほとんどの方式で必須です。
  • -Tenantは、テナント名です(例: contoso.onmicrosoft.com)。リファレンスでは、証明書方式および拇印方式で必須とされています。対話型およびデバイスログインでは省略可能です。

SharePoint管理センターが必要なコマンドでは、-TenantAdminUrlを指定できます。省略した場合、該当する場合にはコマンドレットはhttps://[tenantname]-admin.sharepoint.comの形式を想定します。

手順1: Microsoft Entraでアプリの登録を完了する

この手順では、PnP.PowerShell モジュールがすでにお使いのマシンにインストールされていることを前提としています。PnP には初回設定用のヘルパーが用意されています。Register-PnPEntraIDAppForInteractiveLogin のコマンドレット ページに、最も短い形式が載っています。

Register-PnPEntraIDAppForInteractiveLogin -ApplicationName TestApp -Tenant yourtenant.onmicrosoft.com

サインインするためのブラウザー ウィンドウが開き、コマンドレットがアプリを作成します。また、-ClientId として使用するアプリケーション ID も出力されます。マシンでブラウザーを開けない場合は、-DeviceLogin を追加してください。このページによると、これは多要素認証に対応したデバイス ログインのフローに切り替わります。

アクセス許可には注意してください。基本の例では、アプリは同意のために次の委任されたアクセス許可を要求します: AllSites.FullControl、Group.ReadWrite.All、User.ReadWrite.All、TermStore.ReadWrite.All。同じページの 2 つ目の例では、-GraphDelegatePermissions "Group.Read.All" と -SharePointDelegatePermissions "AllSites.FullControl" を指定して、アクセス許可の範囲を絞っています。

これは最小限の権限の原則において重要です。読み取りのみを行うレポート スクリプトに、ユーザーやグループへの書き込み権限は必要ありません。スクリプトに必要なものを見極め、必要な権限だけを要求してください。

アプリの登録ごとに、その名前、クライアント ID、所有者、保持しているアクセス許可を記録しておいてください。アプリの登録は年に 1 回見直し、どのスクリプトも使用しなくなったら削除してください。

知っておくべき制限が 2 つあります。リファレンス ページには、アプリを登録するために必要な Entra ロールが記載されていないため、作業を始める前に ID 管理者に確認してください。また、-SignInAudience パラメーターはアプリがサポートするアカウントの種類を制御するため、テナントと一致しているか確認してください。

PnP PowerShell で SharePoint Online に接続する方法: 5 つのオプション

5 つの例はすべて Connect-PnPOnline のリファレンスを情報源としています。山かっこ (<>) で囲まれた値は、ご自身の値に置き換えてください。

対話型サインイン

Connect-PnPOnline -Url "https://contoso.sharepoint.com" -Interactive -ClientId <appId>

個人ユーザーにとって標準的な選択肢です。リファレンスによると、多要素認証に対応するように設計されています。保存された認証情報を消去し、別のアカウントでサインインする場合は -ForceAuthentication を追加してください。テスト用テナントと運用テナントを切り替える際に使用します。

デバイス ログイン

Connect-PnPOnline -Url "https://contoso.sharepoint.com" -DeviceLogin -ClientId <appId>

ブラウザーが開き、コードがクリップボードにコピーされます。対話型ウィンドウがうまく動作しないリモート セッションでシェルを実行している場合に選択してください。

証明書によるサインイン (アプリ専用)

Connect-PnPOnline -Url "https://contoso.sharepoint.com" -ClientId <appId> -Tenant 'contoso.onmicrosoft.com' -Thumbprint <thumbprint>

人がサインインすることはありません。アプリは、付与されたアプリケーション アクセス許可を使って自律的に動作します。-CertificatePath と -CertificatePassword、-CertificateBase64Encoded の値、または -Thumbprint を指定できます。拇印 (サムプリント) による方法では、証明書が Windows の証明書ストアに存在する必要があります。サーバー上で無人で実行するスクリプトの標準的な選択肢です。

マネージド ID

Connect-PnPOnline -Url "https://contoso.sharepoint.com" -ManagedIdentity

リファレンスによると、この方法は Azure Functions、Automation のランブック、Cloud Shell など、マネージド ID をサポートする環境でのみ機能します。シークレットを一切保存する必要はありません。ユーザー割り当てマネージド ID を使用する場合は、-UserAssignedManagedIdentityClientId、-UserAssignedManagedIdentityObjectId、-UserAssignedManagedIdentityAzureResourceId のいずれかを追加します。この方法では -Url パラメーターは省略可能です。

資格情報とクライアント シークレット

以前からある方法が 2 つ残っていますが、どちらにも注意事項があります。

  • -Credentials には PSCredential を指定します。たとえば (Get-Credential) や、Windows 資格情報マネージャーに保存された汎用資格情報の名前を指定します。リファレンスには、対話型およびデバイス ログインで多要素認証に対応していると記載されていますが、この方法についてはその記載はありません。プロンプトが表示されないアカウント向けの選択肢として扱い、依存する前に必ずテストしてください。
  • -ClientSecret を -ClientId と組み合わせて使う方法は、従来の ACS 方式です。リファレンスには、この方式では「SharePoint Online に接続するコマンドレットのみが動作します。」と書かれています。Microsoft Graph を使用するコマンドレットは失敗します。

新規に作るものでは、どちらの方式も避けてください。スクリプトにパスワードを書き込むのはリスクがあり、クライアント シークレットは予告なく期限切れになります。

例: 4 つのジョブに対するサインイン方法の選び方

以下の数値と名前は説明のための架空のものです。

ある架空の会社の管理チームが、4 つのジョブを実行しています。すべてを 1 つのアプリで処理するのではなく、リスク レベルごとにアプリを分けたいと考えています。

  1. 管理者がノート PC で行う臨時の確認。 委任されたアクセス許可を最小限に絞ったアプリで -Interactive を使います。管理者は MFA を使ってサインインします。資格情報は保存されません。
  2. リモートのジャンプ サーバーで行う 1 回限りのクリーンアップ。 -DeviceLogin を使います。管理者はスマートフォンまたはノート PC でサインインを完了すると、処理が開始されます。
  3. Windows サーバーで毎晩実行するインベントリ。 -Thumbprint と証明書を使います。アプリにはアプリケーションの読み取り専用アクセス許可を付与します。証明書の有効期間は 12 か月で、チームは更新日を共有カレンダーに登録しています。
  4. Automation の Runbook で毎週実行するジョブ。 -ManagedIdentity を使います。ローテーションが必要な証明書やシークレットはありません。

結果として、人の操作に依存するのはジョブ 1 とジョブ 2 だけです。ジョブ 3 と 4 は誰も立ち会わずに実行され、どちらもパスワードを保存しません。ジョブ 3 のサーバーが盗まれた場合でも、チームは証明書を 1 つ失効させるだけで対応できます。管理者のパスワードをリセットする必要はありません。

どのサインイン方法を選ぶ場合でも、サイト URL は $siteUrl のような変数に保持してください。こうすると、1 つの PowerShell スクリプトでサイトの一覧を順に処理し、各 SharePoint サイトから必要な情報を取得して、レポートをアップロードできます。Microsoft 365 テナント全体で実行する前に、1 つのサイト コレクションに対してスクリプトのテスト実行を行ってください。

よくある間違い

  • -ClientId を指定し忘れる。 接続に失敗するか、ID の入力を求められます。スクリプトを頻繁に実行するマシンでは、ID を ENTRAID_APP_ID 環境変数に保存しておくと便利です。
  • 1 つの強力なアプリをすべてに使う。 既定の登録では AllSites.FullControl と、ユーザーとグループへの書き込みアクセス許可が要求されます。レポート用には、読み取り専用の 2 つ目のアプリを登録してください。
  • Graph ベースのコマンドレットでクライアント シークレットを使う。 従来の方式が使えるのは SharePoint 系のコマンドレットだけです。コマンドが Graph を呼び出す場合は失敗し、エラー メッセージも分かりにくいことがあります。
  • パスワードやシークレットをスクリプト ファイルに書き込む。 そのファイルを読み取れる人は全員、資格情報を取得できてしまいます。証明書ストアやマネージド ID を使ってください。
  • 最終的な環境でサインインをテストしない。 ノート PC で -Interactive を使って動くスクリプトでも、ブラウザーのないサーバーでは失敗することがあります。実際にジョブで使う方法でテストしてください。
  • 誤ったテナントにサインインしたままになる。 アカウントを切り替える際は -ForceAuthentication を使い、各スクリプトの開始時に接続情報を出力してください。

ソフトウェアが役立つ場面

まずは手元にあるものから始めましょう。PnP モジュールと Microsoft Graph PowerShell SDK で、管理用スクリプトの大半をカバーできます。Azure Automation を使えば、マネージド ID でスクリプトをスケジュール実行できます。また、SharePoint 管理センターでは、コードを書かずにサイトや設定を確認できます。シークレットについては、スクリプト ファイルに置くより、証明書ストアやキー コンテナーに保管するほうが安全です。

その上で、レポートを追加してください。接続が正しくできるスクリプトは、最初の一歩にすぎません。チームには、各スクリプトが何を変更したか、どのアプリ ID を使ったかを記録した明確なログも必要です。そうすれば、次の管理者もその作業を追跡できます。ログは、共有リストやチケット システムなど、全員が読める場所に保管してください。

次のステップ

今日のうちに、スクリプトに必要な最小限の委任されたアクセス許可だけを持つアプリを 1 つ登録しましょう。次に、-Interactive を使って PnP PowerShell で SharePoint Online に接続できることを確認してください。そして、スケジュール実行する各ジョブでどのサインイン方法を使うかを書き留めておきましょう。

番組をフォローSpotify

Entities in this article

PnP PowerShell Microsoft Entra PowerShell SharePoint

Related articles

RSS