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

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

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

Microsoft Exchange への接続を設定

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

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

    Import-Module ExchangeCmdlets;

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

    $conn = Connect-Exchange  -User "$User" -Password "$Password" -Server "$Server" -Platform "$Platform"

Microsoft Exchange への接続

Exchange への接続には2つのスキーマがあります。

• Microsoft Graph
• Exchange Web Services（EWS）（非推奨）
  Note：Microsoft は、Exchange Online ユーザーに対してMicrosoft Graph への切り替えを推奨しています。

Microsoft Graph とEWS を切り替えるには、Schema をMSGraph またはEWS（非推奨）に設定します。

Microsoft Exchange OnPremises への認証

Microsoft Exchange OnPremises は、Basic（デフォルト）、Digest、Negotiate、NTLM 認証をサポートします。

Basic（デフォルト）

Microsoft Exchange OnPremises では、Basic がデフォルトの認証として設定されます。 Basic 認証を使用するには、以下のプロパティを設定します。

• AuthScheme：Basic。
• User：ユーザーのログインID。
• Password：ユーザーのログインパスワード。

他の認証方法については、ヘルプドキュメントの「はじめに」を参照してください。

Microsoft Exchange Online への認証

Microsoft Exchange Online は、複数のOAuth ベースの認証をサポートしています。 Microsoft Graph を介してExchange Online に接続する場合は、Schema をMSGraph に設定します。

認証方法の詳細は、ヘルプドキュメントの「はじめに」を参照してください。

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

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

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

Select-Exchange -Connection $conn -Table Contacts | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myContactsData.csv -NoTypeInformation

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

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

データの削除

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

Select-Exchange -Connection $conn -Table Contacts -Where "BusinnessAddress_City = Raleigh" | Remove-Exchange

データの挿入と更新

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

Import-Csv -Path C:\MyContactsUpdates.csv | %{
  $record = Select-Exchange -Connection $Exchange -Table Contacts -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Exchange -Connection $exchange -Table Contacts -Columns ("GivenName","Size") -Values ($_.GivenName, $_.Size) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Exchange -Connection $exchange -Table Contacts -Columns ("GivenName","Size") -Values ($_.GivenName, $_.Size)
  }
}

おわりに

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