PowerShell からSharePoint のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法

CData Cmdlets for SharePoint を使えば、PowerShell からSharePoint に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、SharePoint への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

SharePoint への接続を設定

それでは、まずはSharePoint への接続設定からはじめていきましょう。接続設定にはCData SharePoint Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module SharePointCmdlets;

Connect-SharePoint コマンドを使ってSharePoint との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-SharePoint  -User "$User" -Password "$Password" -Auth Scheme "$Auth Scheme" -URL "$URL" -SharePointEdition "$SharePointEdition"

Microsoft SharePoint への接続

URL の設定：

Microsoft SharePoint では、2つの範囲でデータを操作できます。グローバルなMicrosoft SharePoint サイト全体を対象にするか、個々のサイトのみを対象にするかを選択できます。

グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作したい場合は、URL 接続プロパティをサイトコレクションURL に設定しましょう。以下のような形式です。

https://teams.contoso.com

個々のサイトのリストおよびドキュメントのみを扱いたい場合は、URL 接続プロパティを個々のサイトURL に設定してください。以下のような形式です。

https://teams.contoso.com/TeamA

続いて、お使いの環境に適した認証プロパティを設定していきましょう。詳細な設定手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご参照ください。

Microsoft SharePoint Online

SharePointEdition を"SharePoint Online" に設定し、User およびPassword にはSharePoint へのログオンで使用するクレデンシャル（例：Microsoft Online Services アカウントのクレデンシャル）を設定します。

Microsoft SharePoint Online は様々なクラウドベースアーキテクチャをサポートしており、それぞれ異なる認証スキームが利用できます。

• Microsoft Entra ID（Azure AD）
• ADFS、Okta、OneLogin、またはPingFederate SSO ID プロバイダーを介したシングルサインオン（SSO）
• Azure MSI
• Azure パスワード
• OAuthJWT
• SharePointOAuth

Microsoft SharePoint オンプレミス

Microsoft SharePoint オンプレミスでは、多くのオンプレミス環境に対応した認証方式をサポートしています。

• Windows（NTLM）
• Kerberos
• ADFS
• 匿名アクセス

まずSharePointEdition を"SharePoint On-Premises" に設定しましょう。

Windows（NTLM）認証

これは最も一般的な認証方式です。そのため、CData 製品ではNTLM をデフォルトとして使用するよう事前設定されています。Windows のUser およびPassword を設定するだけで接続できます。

これで接続設定は完了です。

SharePoint のデータを取得してCSV にパイプライン

接続が完了したので、MyCustomList テーブルデータを取得して結果をCSV ファイルにエクスポートします。

Select-SharePoint -Connection $conn -Table MyCustomList | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myMyCustomListData.csv -NoTypeInformation

このコードでは、Select-SharePoint から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

それでは、続いてデータの削除や挿入・更新を実行してみます。

データの削除

以下のように、フィルタリングで合致するレコードを削除することができます。

Select-SharePoint -Connection $conn -Table MyCustomList -Where "Location = Chapel Hill" | Remove-SharePoint

データの挿入と更新

データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。

Import-Csv -Path C:\MyMyCustomListUpdates.csv | %{
  $record = Select-SharePoint -Connection $SharePoint -Table MyCustomList -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-SharePoint -Connection $sharepoint -Table MyCustomList -Columns ("Name","Revenue") -Values ($_.Name, $_.Revenue) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-SharePoint -Connection $sharepoint -Table MyCustomList -Columns ("Name","Revenue") -Values ($_.Name, $_.Revenue)
  }
}

おわりに

このように、CData Cmdlets を使えばPowerShell でのSharePoint のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。