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

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

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

   Microsoft SharePoint への接続

   URL の設定：

   Microsoft SharePoint では、2つの範囲でデータを操作できます。グローバルなMicrosoft SharePoint サイト全体を対象にするか、個々のサイトのみを対象にするかを選択できます。

   グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作したい場合は、URL 接続プロパティをサイトコレクションURL に設定しましょう。以下のような形式です。

   https://teams.contoso.com

   個々のサイトのリストおよびドキュメントのみを扱いたい場合は、URL 接続プロパティを個々のサイトURL に設定してください。以下のような形式です。

   https://teams.contoso.com/TeamA

   続いて、お使いの環境に適した認証プロパティを設定していきましょう。詳細な設定手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご参照ください。

   Microsoft SharePoint Online

   SharePointEdition を"SharePoint Online" に設定し、User およびPassword にはSharePoint へのログオンで使用するクレデンシャル（例：Microsoft Online Services アカウントのクレデンシャル）を設定します。

   Microsoft SharePoint Online は様々なクラウドベースアーキテクチャをサポートしており、それぞれ異なる認証スキームが利用できます。

   • Microsoft Entra ID（Azure AD）
   • ADFS、Okta、OneLogin、またはPingFederate SSO ID プロバイダーを介したシングルサインオン（SSO）
   • Azure MSI
   • Azure パスワード
   • OAuthJWT
   • SharePointOAuth

   Microsoft SharePoint オンプレミス

   Microsoft SharePoint オンプレミスでは、多くのオンプレミス環境に対応した認証方式をサポートしています。

   • Windows（NTLM）
   • Kerberos
   • ADFS
   • 匿名アクセス

   まずSharePointEdition を"SharePoint On-Premises" に設定しましょう。

   Windows（NTLM）認証

   これは最も一般的な認証方式です。そのため、CData 製品ではNTLM をデフォルトとして使用するよう事前設定されています。Windows のUser およびPassword を設定するだけで接続できます。

   
   <configuration>
      ... <connectionStrings>
       <add name="SharePointContext" connectionString="Offline=False;User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;" providerName="System.Data.CData.SharePoint" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.SharePoint" type="System.Data.CData.SharePoint.SharePointProviderServices, System.Data.CData.SharePoint.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

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

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

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