Blazor でAzure DevOps のデータにリアルタイムで連携するアプリを構築

こんにちは！リードエンジニアの杉本です。

Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。

CData ADO.NET Provider for AzureDevOps は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってAzure DevOps を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からAzure DevOps に接続して直接SQL クエリを実行する方法を説明します。

CData ADO.NET Provider for AzureDevOps のインストール

CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL（もしくはDapper などのORM を挟んでもいいです）であり、Azure DevOps のデータへもRDB と同感覚でアクセスが可能になります。

CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。Azure DevOps ADO.NET Data Provider で検索してください。

Blazor でAzure DevOps にデータ連携するアプリを構築

Blazor にADO.NET Provider for AzureDevOps を接続

• Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。

• ソリューションエクスプローラーで「依存関係」から右クリックで「プロジェクト参照の追加」をクリック。
• 参照マネージャーが開くので、「参照」ボタンをクリックして、先ほどインストールしたADO.NET Provider の.dll を選択します。「C:\Program Files\CData\CData ADO.NET Provider for AzureDevOps 2019J\lib etstandard2.0」内のSystem.Data.CData.AzureDevOps.dll」を参照に選びます。

Blazor でAzure DevOps のデータをSELECT

サンプルプロジェクトの「Page」→「Index.razor」を開きます。

以下のコードを書きます。使っているクエリはおなじみの標準SQL です。Azure DevOps 固有のAPI を書かなくてもRDB と同感覚でSQL が書けるところがADO.NET Prover for AzureDevOps の強味です。

      @page "/"
      @using System.Data;
      @using System.Data.CData.AzureDevOps;

      <h1>Hello, world!</h1>

      Welcome to your Data app.

      <div class="row">
          <div class="col-12">

              @using (AzureDevOpsConnection connection = new AzureDevOpsConnection(
                "AuthScheme=Basic;Organization=MyAzureDevOpsOrganization;ProjectId=MyProjectId;PersonalAccessToken=MyPAT;"))
              {
                  var sql = "SELECT Id, BuildNumber FROM Builds WHERE Reason = 'Manual'";
                  var results = new DataTable();

                  AzureDevOpsDataAdapter dataAdapter = new AzureDevOpsDataAdapter(sql, connection);
                  dataAdapter.Fill(results);

                  <table class="table table-bordered">
                      <thead class="thead-light">
                          <tr>
                              @foreach (DataColumn item in results.Rows[0].Table.Columns)
                              {
                                  <th scope="col">@item.ColumnName</th>
                              }
                          </tr>
                      </thead>
                      <tbody>
                          @foreach (DataRow row in results.Rows)
                          {
                              <tr>
                                  @foreach (var column in row.ItemArray)
                                  {
                                      <td>@column.ToString()</td>
                                  }
                              </tr>
                          }
                      </tbody>
                  </table>
              }
          </div>
      </div>
    

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

Azure DevOps アカウントに接続するには、Profile -> Organizations に移動し、アカウントの組織名を取得します。Organization プロパティをこの値に設定します。

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

Azure DevOps への認証

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

Basic

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

Azure AD

Azure AD は、Microsoft のマルチテナント、クラウドベースのディレクトリおよびID 管理サービスです。 これはユーザーベースの認証で、AuthScheme をAzureAD に設定し、Organization をAzure DevOps Organization の名前に設定する必要があります。 Web アプリケーションを介したAzure AD への認証には、必ずカスタムOAuth アプリケーションの作成が必要です。 詳しい認証方法は、ヘルプドキュメント の「Azure DevOps への認証」セクションを参照してください。

プロジェクトをリビルドして実行します。このようにAzure DevOps からデータを直接取得し、HTML テーブル形式にレンダリングしています。

もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。

まとめ