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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

Office 365 への接続を設定

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

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

    Import-Module Office365Cmdlets;

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

    $conn = Connect-Office365  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -OAuthCallbackURL "$OAuthCallbackURL"

Office 365 はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。認証方法については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

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

Office 365 データを取得してCSV にパイプライン

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

Select-Office365 -Connection $conn -Table Files | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myFilesData.csv -NoTypeInformation

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

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

データの削除

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

Select-Office365 -Connection $conn -Table Files -Where "UserId = 54f34750-0d34-47c9-9949-9fac4791cddb" | Remove-Office365

データの挿入と更新

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

Import-Csv -Path C:\MyFilesUpdates.csv | %{
  $record = Select-Office365 -Connection $Office365 -Table Files -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Office365 -Connection $office365 -Table Files -Columns ("Name","Size") -Values ($_.Name, $_.Size) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Office365 -Connection $office365 -Table Files -Columns ("Name","Size") -Values ($_.Name, $_.Size)
  }
}

おわりに

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