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

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

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

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

Microsoft Dataverse への接続を設定

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

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

    Import-Module CDSCmdlets;

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

    $conn = Connect-CDS  -OrganizationUrl "$OrganizationUrl"

ユーザー資格情報の接続プロパティを設定せずに接続できます。接続に最小限必要な接続プロパティは、以下のとおりです。

• InitiateOAuth: GETANDREFRESH に設定します。
• OrganizationUrl: 接続先の組織のURL、例えばhttps://organization.crm.dynamics.com などに設定。
• Tenant (optional): デフォルトと異なるテナントに認証したい場合は、これを設定します。これは、デフォルトのテナントに所属していない組織と連携するために必要です。

接続すると、CData 製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、CData 製品にアクセス許可を与えます。CData 製品がOAuth プロセスを完了します。

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

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

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

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

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

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

データの削除

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

Select-CDS -Connection $conn -Table Accounts -Where "Name = MyAccount" | Remove-CDS

データの挿入と更新

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

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

おわりに

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