Entity Framework 6 からAzure DevOps のデータに連携

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

Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでAzure DevOps にアクセスします。

1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
2. Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
3. プロジェクトのApp.config ファイルを修正して、Azure DevOps Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。

   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 への認証」セクションを参照してください。

   <configuration> ... <connectionStrings> <add name="AzureDevOpsContext" connectionString="Offline=False;AuthScheme=Basic;Organization=MyAzureDevOpsOrganization;ProjectId=MyProjectId;PersonalAccessToken=MyPAT;" providerName="System.Data.CData.AzureDevOps" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.AzureDevOps" type="System.Data.CData.AzureDevOps.AzureDevOpsProviderServices, System.Data.CData.AzureDevOps.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.AzureDevOps.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はAzureDevOpsContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class AzureDevOpsContext :DbContext { public AzureDevOpsContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<AzureDevOpsContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているAzure DevOps のエンティティ、例えばBuilds にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Builds { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String Id { get; set; } } public class BuildsMap :EntityTypeConfiguration<Builds> { public BuildsMap() { this.ToTable("Builds"); this.HasKey(Builds => Builds.Id); this.Property(Builds => Builds.Id); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<Builds> Builds { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： AzureDevOpsContext context = new AzureDevOpsContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Builds select line;