クイックスタート: .NET 用 SDK 要求を実行する (C#)

2025-07-01

この記事では、SDK for .NET アセンブリのクラスを使用して、Microsoft Dataverse のビジネスデータを扱う方法について説明します。 ServiceClient クラスを使用して環境の Organization サービスに接続し、Web サービス操作を実行するための最小限のコンソールアプリケーションを作成します。

アプリケーションは、WhoAmIRequest クラスのインスタンスを渡して IOrganizationService.Execute メソッドを呼び出します。 Web サービスから返される結果は、Dataverse システムユーザーアカウントの一意の識別子である WhoAmIResponse.UserId の値です。

注意

このクイックスタートの例には、簡潔にするために例外処理は含まれていません。このクイックスタートは、SDK for .NET に接続して使用するために必要なものの最小コード例です。

完全なコードサンプルは、GitHub の GetStarted から入手できます。詳細については、プログラムの README を参照してください。

前提条件

Visual Studio (2022 以降)
インターネット接続
ターゲット環境の Dataverse システムユーザーアカウントのログオン資格情報
接続先の Dataverse 環境の URL アドレス
Visual C# 言語の基本的な理解

アプリケーションコードでの接続文字列またはユーザー名/パスワード認証の使用については、次の重要な情報をお読みください。

重要

Microsoft では、利用可能な最も安全な認証フローを使用することをお勧めします。この記事で説明する認証フローは、アプリケーションに対する非常に高い信頼を必要とし、他のフローには存在しないリスクを伴います。このフローは、マネージド ID など、他のより安全なフローが実行できない場合にのみ使用してください。

Visual Studio プロジェクトの作成

新しい .NET コンソールアプリプロジェクトを作成します。このプロジェクトでは、Visual Studio 2022を使用し、.NET 6 をターゲットとしています。
Solution Explorer で、作成したプロジェクトを右クリックして、コンテキストメニューで NuGet パッケージの管理... を選択します。
Microsoft.PowerPlatform.Dataverse.Client NuGet パッケージの最新バージョンを参照して、インストールします。

注意

プレビューの変更で OK を促されるので、ライセンスの同意 ダイアログで 同意する を選択します。

アプリケーションコードを選択します

ソリューションエクスプローラーで Program.cs をダブルクリックして、そのファイルを編集します。ファイルの内容を以下に示すコードに置き換えます。

using Microsoft.Crm.Sdk.Messages;
using Microsoft.PowerPlatform.Dataverse.Client;
using Microsoft.Xrm.Sdk;

class Program
{
   // TODO Enter your Dataverse environment's URL and logon info.
   static string url = "https://yourorg.crm.dynamics.com";
   static string userName = "you@yourorg.onmicrosoft.com";
   static string password = "yourPassword";

   // This service connection string uses the info provided above.
   // The AppId and RedirectUri are provided for sample code testing.
   static string connectionString = $@"
   AuthType = OAuth;
   Url = {url};
   UserName = {userName};
   Password = {password};
   AppId = 51f81489-12ee-4a9e-aaae-a2591f45987d;
   RedirectUri = app://58145B91-0C36-4500-8554-080854F2AC97;
   LoginPrompt=Auto;
   RequireNewInstance = True";

   static void Main()
   {
      //ServiceClient implements IOrganizationService interface
      IOrganizationService service = new ServiceClient(connectionString);

      var response = (WhoAmIResponse)service.Execute(new WhoAmIRequest());

      Console.WriteLine($"User ID is {response.UserId}.");


      // Pause the console so it does not close.
      Console.WriteLine("Press the <Enter> key to exit.");
      Console.ReadLine();
   }
}

// TODO コードのコメントに示されているように、url、userName、password の値を変更します。

ヒント

環境 URLは、レガシ Web アプリケーションの 設定 > カスタマイズ > 開発者リソースまたは Power Apps の設定 (歯車のアイコン) >開発者リソース にあります。

このコードサンプルでは、わかりやすくするためにコード内にユーザー名/パスワード情報を配置していますが、他のコードサンプルでは、その情報の入力を求めるか、別の App.config ファイルまたは appsettings.json ファイルに格納するという、より推奨される方法を使用しています。

AuthType でサポートされる値の一覧は、接続文字列のパラメーターにあります。

プログラムを実行する

F5 キーを押してプログラムを実行します。出力は次のようになります。

User ID is 00aa00aa-bb11-cc22-dd33-44ee44ee44ee
Press any key to exit.

IOrganizationService インターフェイスメソッドを使用する

注意: このプログラムが使用する Dataverse.Client.ServiceClient には、Execute メソッドを含む IOrganizationService インターフェイスが実装されています。

より深く IOrganizationService インターフェイスを理解するためには、次をお試しください。

WhoAmIRequest クラスの参考記事に移動します。

その記事からサンプルメソッドをコピーします。次のようになります。

/// <summary>
/// Outputs the data returned from the WhoAmI message
/// </summary>
/// <param name="service">Authenticated client implementing the IOrganizationService interface</param>
static void WhoAmIExample(IOrganizationService service) {

   var response = (WhoAmIResponse)service.Execute(new WhoAmIRequest());

   Console.WriteLine($"OrganizationId:{response.OrganizationId}");
   Console.WriteLine($"BusinessUnitId:{response.BusinessUnitId}");
   Console.WriteLine($"UserId:{response.UserId}");

}

注意: これは IOrganizationService サービスインスタンスをパラメーターとして受け入れます。

この WhoAmIExample メソッドを、プログラムの Main メソッドの下に貼り付けます

このプログラムの Main メソッドを、以下と置き換えます。

    static void Main()
 {
     //ServiceClient implements IOrganizationService interface
     IOrganizationService service = new ServiceClient(connectionString);

     WhoAmIExample(service: service);

     // Pause the console so it does not close.
     Console.WriteLine("Press the <Enter> key to exit.");
     Console.ReadLine();
 }

このサンプルを再実行すると、次のように表示されるはずです。

OrganizationId:00aa00aa-bb11-cc22-dd33-44ee44ee44ee
BusinessUnitId:11bb11bb-cc22-dd33-ee44-55ff55ff55ff
UserId:22cc22cc-dd33-ee44-ff55-66aa66aa66aa
Press the <Enter> key to exit.

次のステップ

これで、Dataverse に接続する単純なコンソールプログラムが完成しました。このプロジェクトを使用して、他のメソッドやメッセージをお試しください。このクイックスタートコンソールアプリケーションプロジェクトを使用して、アドホックテストを実施できます。

他の IOrganizationService インターフェイスメソッドを試す

チップ

ドキュメントには、この WhoAmIExample のように IOrganizationService service のパラメーターを受け付けるメソッドのサンプルが多くあります。

これらの IOrganizationService methods メソッドの例を試してください。

その他のメッセージを試す

Execute method を使用して呼び出せる他のメッセージは、次の名前空間で見つけることができます。

レコードデータの操作方法について説明します

Dataverse テーブルが含むビジネスデータの操作方法について、次の記事で説明します。

サンプルコードを探索する

.NET 用 SDK のサンプルコードは、Microsoft の GitHub リポジトリ PowerApps-Samples/dataverse/orgsvc に用意されています。

ServiceClient 拡張機能を使用する

IOrganizationService インターフェイスの実装に加えて、ServiceClient は、IOrganizationService によって定義されたコアメソッドを超える拡張メソッドと、ILogger によるログを有効化する機能を提供します。 ServiceClient の使用に関する詳細情報

次の方法で共有

クイックスタート: .NET 用 SDK 要求を実行する (C#)

前提条件

Visual Studio プロジェクトの作成

アプリケーション コードを選択します

プログラムを実行する

IOrganizationService インターフェイス メソッドを使用する

次のステップ

他の IOrganizationService インターフェイス メソッドを試す

その他のメッセージを試す

レコード データの操作方法について説明します

サンプル コードを探索する