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

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

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

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

Azure DevOps への接続を設定

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

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

    Import-Module AzureDevOpsCmdlets;

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

    $conn = Connect-AzureDevOps  -AuthScheme "$AuthScheme" -Organization "$Organization" -ProjectId "$ProjectId" -PersonalAccessToken "$PersonalAccessToken"

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

Azure DevOps アカウントに接続するには、Profile -> Organizations に移動して、アカウント内の組織名であるOrganization を指定します。

例： Organization=MyAzureDevOpsOrganization

NOTE ：Analytics スキーマに接続する場合は、Organization と一緒にProjectId を指定する必要があります。

Azure DevOps への認証

Basic

Organization とPersonalAccessToken を指定することで、Azure DevOps アカウントに接続できます。 パーソナルアクセストークンを生成するには、Azure DevOps Organization アカウントにログインし、Profile -> Personal Access Tokens -> New Token に移動します。生成されたトークンが表示されます。

Azure AD

Azure ADは、OAuth を利用して認証する接続形式です。OAuth は、認証ユーザーがインターネットブラウザを使用してAzure DevOps と通信することを要求します。 CData 製品は、いくつかの方法でこれをサポートします。AuthScheme をAzureAD に設定し、Organization をAzure DevOps の組織名に設定します。 詳しくは、ヘルプドキュメント の「Azure DevOps への認証」セクションを参照してください。

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

Azure DevOps データを取得してCSV にパイプライン

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

Select-AzureDevOps -Connection $conn -Table Builds | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myBuildsData.csv -NoTypeInformation

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

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

データの削除

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

Select-AzureDevOps -Connection $conn -Table Builds -Where "Reason = Manual" | Remove-AzureDevOps

データの挿入と更新

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

Import-Csv -Path C:\MyBuildsUpdates.csv | %{
  $record = Select-AzureDevOps -Connection $AzureDevOps -Table Builds -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-AzureDevOps -Connection $azuredevops -Table Builds -Columns ("Id","BuildNumber") -Values ($_.Id, $_.BuildNumber) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-AzureDevOps -Connection $azuredevops -Table Builds -Columns ("Id","BuildNumber") -Values ($_.Id, $_.BuildNumber)
  }
}

おわりに

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