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

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

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

   OAuth 認証の設定

   Microsoft Graph API は認証に OAuth 2.0 を使用します。OAuth 認証情報（Client ID と Client Secret）を取得するには、Microsoft Azure Portal でアプリケーションを登録する必要があります。

   OAuth 認証情報の取得

   1. Azure Portal にログインします。
   2. Azure Active Directory > App registrations に移動します。
   3. New registration をクリックして新しいアプリケーションを作成します。
   4. アプリケーション名を入力し、適切なアカウントの種類を選択します。
   5. Redirect URI をアプリケーションのコールバック URL に設定します（デスクトップアプリの場合は http://localhost:33333 など）。
   6. Register をクリックしてアプリケーションを作成します。
   7. アプリケーションの概要ページで Application (client) ID をコピーします。これが OAuthClientId になります。
   8. Certificates & secrets に移動して、新しいクライアントシークレットを作成します。
   9. クライアントシークレットの値をコピーします。これが OAuthClientSecret になります。
   10. API permissions に移動して、必要な Microsoft Graph API の権限を追加します：
       • Mail.Read - メールメッセージへのアクセス用
       • Contacts.Read - 連絡先へのアクセス用
       • Calendars.Read - カレンダーイベントへのアクセス用
       • Tasks.Read - To Do タスクへのアクセス用
       • offline_access - リフレッシュトークンの取得用
   11. Grant admin consent をクリックして、これらの権限を付与します。

   OAuth での接続

   以下の接続プロパティを設定して接続を確立してください：

   • AuthScheme：OAuth に設定します。
   • InitiateOAuth：GETANDREFRESH に設定します。CData API Profile for Outlook が OAuth プロセスを自動的に進め、アクセストークンを取得します。
   • OAuthClientId：Azure Portal の Application (client) ID に設定します。
   • OAuthClientSecret：Azure Portal のクライアントシークレットの値に設定します。
   • TenantId：Azure AD のテナント識別子（GUID または 'contoso.onmicrosoft.com' のようなドメイン名）に設定します。
   • CallbackURL：アプリ登録で指定したリダイレクト URI に設定します（デスクトップアプリの場合は http://localhost:33333 など）。

   接続文字列の例

   Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;
   

   
   <configuration>
      ... 
     <connectionStrings>
       <add name="APIContext" connectionString="Offline=False;Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;" providerName="System.Data.CData.API" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.API" type="System.Data.CData.API.APIProviderServices, System.Data.CData.API.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.API.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はAPIContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class APIContext :DbContext {
   	public APIContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<APIContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているOutlook のエンティティ、例えばCalendarGroupCalendars にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class CalendarGroupCalendars {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String  { get; set; }
   }
   public class CalendarGroupCalendarsMap :EntityTypeConfiguration<CalendarGroupCalendars> {
   	public CalendarGroupCalendarsMap() {
   		this.ToTable("CalendarGroupCalendars");
   		this.HasKey(CalendarGroupCalendars => CalendarGroupCalendars.Id);
   		this.Property(CalendarGroupCalendars => CalendarGroupCalendars.);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

   
   public DbSet<CalendarGroupCalendars> CalendarGroupCalendars { set; get; }
   

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

   APIContext context = new APIContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.CalendarGroupCalendars select line;