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

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

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

OneNote への接続を設定

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

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

    Import-Module OneNoteCmdlets;

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

    $conn = Connect-OneNote  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL"

Microsoft OneNote データ ソースへの接続には、次の 2 つの認証方法があります。

• OAuth 2.0 ベースの方法: Microsoft OneNote は、Azure AD を介してOAuth 2.0 ベースの認証を提供します。Azure AD 認証の場合は、AuthScheme をAzureAD に設定します。
• マネージド サービス ID (MSI) 認証。この方法を使用するには、AuthScheme をAzureMSI に設定します。

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

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

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

Select-OneNote -Connection $conn -Table Notebooks | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myNotebooksData.csv -NoTypeInformation

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

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

データの削除

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

Select-OneNote -Connection $conn -Table Notebooks -Where "Id = Jq74mCczmFXk1tC10GB" | Remove-OneNote

データの挿入と更新

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

Import-Csv -Path C:\MyNotebooksUpdates.csv | %{
  $record = Select-OneNote -Connection $OneNote -Table Notebooks -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-OneNote -Connection $onenote -Table Notebooks -Columns ("Id","notebook_displayName") -Values ($_.Id, $_.notebook_displayName) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-OneNote -Connection $onenote -Table Notebooks -Columns ("Id","notebook_displayName") -Values ($_.Id, $_.notebook_displayName)
  }
}

おわりに

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