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

CData PowerShell Cmdlets を使って、Azure DevOps のデータに接続、データの取得・更新・挿入・削除・CSV エクスポートを実行する方法を紹介します。

加藤龍彦
デジタルマーケティング

最終更新日:2023-09-26

この記事で実現できるAzure DevOps 連携のシナリオ

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

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 プロパティをこの値に設定します。

Note: 複数のカタログやスキーマに存在するテーブル名もあります。テーブルをクエリする際は、Catalog およびSchema 接続プロパティ、または完全修飾テーブル名のいずれかでカタログとスキーマを指定する必要があります。

Azure DevOps への認証

Azure DevOps は、Basic 認証とAzure AD(OAuth ベース)認証の両方をサポートします。

Basic

Basic 認証でAzure DevOps に接続する場合、OrganizationPersonalAccessToken の両方を指定します。 パーソナルアクセストークンを生成するには、Azure DevOps 組織アカウントにログインし、Profile -> Personal Access Tokens -> New Token に移動します。生成されたトークンが表示されます。

Azure AD

Azure AD は、Microsoft のマルチテナント、クラウドベースのディレクトリおよびID 管理サービスです。 これはユーザーベースの認証で、AuthSchemeAzureAD に設定し、Organization をAzure DevOps Organization の名前に設定する必要があります。 Web アプリケーションを介したAzure AD への認証には、必ずカスタムOAuth アプリケーションの作成が必要です。 詳しい認証方法は、ヘルプドキュメント の「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日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。