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

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

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

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

Dynamics 365 への接続を設定

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

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

    Import-Module Dynamics365Cmdlets;

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

    $conn = Connect-Dynamics365  -Dynamics365Edition "$Dynamics365Edition" -Tenant "$Tenant" -OrganizationUrl "$OrganizationUrl" -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL"

Dynamics 365 接続プロパティの取得・設定方法

Dynamics365 Online、オンプレミス、およびOnPremise IFD (Internet-facing deployment) に接続することができます。すべてのエディションで、OrganizationalUrl がログインで利用するURL に設定される必要があります。 オンプレミス版の場合には、追加でUser およびPassword 接続プロパティを入力する必要があります。

Online 版およびOnPremise IFD 版は、OAuth 値を指定する必要があります。詳細はヘルプドキュメントの「はじめに」を参照してください。

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

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

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

Select-Dynamics365 -Connection $conn -Table Accounts | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAccountsData.csv -NoTypeInformation

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

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

データの削除

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

Select-Dynamics365 -Connection $conn -Table Accounts -Where "address1_city = Raleigh" | Remove-Dynamics365

データの挿入と更新

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

Import-Csv -Path C:\MyAccountsUpdates.csv | %{
  $record = Select-Dynamics365 -Connection $Dynamics365 -Table Accounts -Where ("AccountId = `'"+$_.AccountId+"`'")
  if($record){
    Update-Dynamics365 -Connection $dynamics365 -Table Accounts -Columns ("Name","NumberOfEmployees") -Values ($_.Name, $_.NumberOfEmployees) -Where ("AccountId = `'"+$_.AccountId+"`'")
  }else{
    Add-Dynamics365 -Connection $dynamics365 -Table Accounts -Columns ("Name","NumberOfEmployees") -Values ($_.Name, $_.NumberOfEmployees)
  }
}

おわりに

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