.NET 用 SDK は、Dataverse プラットフォームでサポートされるビジネス データ、データ テーブル定義 (メタデータ)、およびデータ操作へのアクセスを提供します。
特定の開発シナリオでは、Dataverse .NET 用 SDK を使用する必要があります。 プラグインやカスタム ワークフロー アクティビティを作成する場合など、Dataverse の機能を拡張するカスタム コードを記述する場合は、.NET Framework と Dataverse SDK を使用してコードをビルドする必要があります。
SDK アセンブリの入手
.NET Framework または .NET Core ベースのアプリケーションには、.NET 用 SDK アセンブリを使用します。 .NET Framework のみの開発の場合、Microsoft.CrmSdk.CoreAssemblies NuGet パッケージの SDK アセンブリを使用できます。 .NET Framework または .NET Core 開発の場合、Microsoft.PowerPlatform.Dataverse.Client NuGet パッケージの SDK アセンブリを使用できます。
NuGet パッケージを Visual Studio プロジェクトに追加すると、アプリケーションが組織サービスおよび検出 Webサービスと対話できるようにする名前空間とクラスにアクセスできます。
組織サービスとのやり取り
このセクションでは、提供されている SDK クラスを使用して Web サービスに接続し、操作を実行するためのいくつかの重要な概念について説明します。
Web サービスの接続を確立する
IOrganizationService インターフェイスは、組織サービスへの接続を提供し、アプリケーションがビジネス データ、およびテーブルと列の定義を操作できるようにします。 SDK には、このインターフェイスの 2 つの実装 CrmServiceClient および ServiceClient があります。 新しいアプリケーションを開発する場合は、新しい認証テクノロジー (MSAL) をサポートし、CrmServiceClient では利用できないいくつかの機能を持つ ServiceClient クラスを使用する必要があります。 ただし、両方のクライアント クラスは、API の観点からはほとんど同じです。 このドキュメントには、これらのクラスのいずれかを使用したコードサンプルが掲載されていますが、CrmServiceClient を使用したコードを ServiceClient に変換するのは非常に簡単です。
詳細: アプリを Dataverse ServiceClient に移行する、IOrganizationService インターフェイス
Web サービスの操作
Dataverse .NET 用 SDK では、Web サービス操作は、サービスへメッセージまたはメッセージ要求を送信することにより開始されます。 各メッセージには、メッセージの目的を示す名前があり、対応する要求クラス名はそのメッセージ名に基づいています。 たとえば、テーブルにデータの行を作成するには、作成要求にデータを入力し、サービス クライアントでこの要求を組織サービスに送信 (実行) します。 操作は「作成」であり、メッセージ要求にはCreateRequestという名前が付けられます。 要求を実行すると、サービスは実行ステータスと結果データを含む応答クラス オブジェクト (CreateResponse など) を返します。 このパターンは、サービスがサポートする他の操作で同じです。
Microsoft.Xrm.Sdk.Messages および Microsoft.Crm.Sdk.Messages 名前空間で利用可能なメッセージ要求とおよび応答のクラスを確認してください。
レガシ SOAP エンドポイントについて
SOAP エンドポイントと呼ばれる組織サービス エンドポイントは、2011 年に導入されました。 このエンドポイントは非推奨です。 これは、削除されるまで引き続き機能し、サポートされることを意味します。 また、エンドポイントが削除された後も動作するよう、SDK for .NET アセンブリを更新することも発表しました。 つまり、エンドポイントが削除される前に、更新された SDK for .NET アセンブリを使用できます。 開発者は、今後ある時点で、これらの新しいアセンブリを使用するようにコードを更新する必要があります。 重要なポイントは、開発者は SDK for .NET を使用して組織サービスにアクセスし、エンドポイントとそのプロトコルを無視することです。 詳細: アプリを Dataverse ServiceClient に移行する
Web API は別のエンドポイントを使用するため、この 2011 年の SOAP エンドポイントの非推奨による影響はありません。
次の手順
コードを記述しましょう! クイックスタート: .NET 用 SDK のサンプル (C#)