Visual Studio (C#) で Microsoft Dataverse Web API プロジェクトを使う

[アーティクル]
03/04/2022

このトピックでは、Dataverse Web API を使用するコンソールアプリケーションを構築する新しいプロジェクトを Visual Studio 2017 (またはそれ以降) で作成する方法を示します。 SDK C# サンプルを含む多くのアプリケーションが、Web API ベースのソリューションを実装するのに使用する共通の参照およびプロジェクトのリソースを説明します。

前提条件

次の前提条件は、このセクションで説明されているコンソールアプリケーションを作成するのに必要です。

開発用コンピューターには Visual Studio 2017 がインストールされています。 Visual Studio Express など、どのエディションでも Dataverse Web API は十分に操作できます。
次の NuGet クライアントをインストールする必要があります: コマンドラインユーティリティまたは Visual Studio 拡張。詳細については、NuGet のインストールを参照してください。

プロジェクトの作成

以下の手順では、Microsoft .NET Framework を使用する C# でコンソールアプリケーションプロジェクトを作成する方法を説明します。

新しいプロジェクト

Visual Studio では、新しいプロジェクト をクリックします。 新しいプロジェクト ダイアログが表示されます。
テンプレート の下の左側のナビゲーションウィンドウで、Visual C# を選択します。
使用可能なテンプレートの一覧の上側で、.NET Framework 4.6.2 を選択します。
テンプレートの一覧から コンソールアプリ (.NET Framework) を選択します。 (ソリューションに適したプロジェクトの種類を選択してください)。すべての Web API C# はコンソールアプリケーションです。
フォームの下部近くのテキストボックスに、プロジェクトの名前と場所を入力し、[OK] を選択します。 (このトピックでは、ソリューション名 "StartWebAPI-CS" が使用されています。) 最初のソリューションファイルが作成され、ソリューションは Visual Studio に読み込まれます。
プロジェクト メニューで、プロジェクトのプロパティフォームを開き、ターゲットフレームワークが .NET Framework 4.6.2 に設定されていることを確認します。

必要なアセンブリ参照をインストールして確認します。

プロジェクトを開いたら、プロジェクト上部のコントロールバーにある ツール をクリックします。 NuGet パッケージマネージャー > パッケージマネージャーコンソール を選択し、次の NuGet パッケージをインストールします。

install-package Newtonsoft.Json
install-package System.Net.Http

ソリューションエクスプローラー では、参照ノードを展開します。
必要なすべての参照がプロジェクトに追加されたことを確認してください。
アプリケーション内で定期的に使用する追加機能がある場合は、必要なアセンブリへ関連する参照を追加することができます。詳細については、「[参照の追加] ダイアログボックスを使用して参照の追加または削除する方法」を参照してください。

Dataverse Web API は REST の原則をベースとしているので、クライアント側アセンブリがアクセスする必要はありません。ただし、Dataverse アプリでサポートされる他の API にはこれらが必要です。

一般的な using ステートメントの追加

ソリューションエクスプローラー で、編集に対して Program.cs を開きます。
ファイルの先頭に、Dataverse Web API ベースのソリューションで一般的に使用されている名前空間を参照する、次の using ステートメントを追加します。
```
using Newtonsoft.Json;  
using Newtonsoft.Json.Linq;  
using System.Net.Http;  
using System.Net.Http.Headers;
```
前のセクションで日常的に使用されているアセンブリまたは参照を追加した場合は、対応する using ステートメントをこれらのリソースに対して追加する必要もあります。
ファイルを保存します。

つながりコードの追加

このセクションでは、これらの操作を実行する上で基本となる一連の設定と説明を追加する方法について説明します。

アプリケーション構成ファイルの編集

ソリューションエクスプローラー で、編集に対して App.config ファイルを開きます。既存の <startup> セクションの後に、次の 2 つのセクションをそれに追加し、ファイルを保存します。


<connectionStrings>  
    <clear />  

    <!-- When providing a password, make sure to set the app.config file's security so that only you can read it. -->  
    <add name="default"   connectionString="Url=https://myserver/myorg/; Username=name; Password=password; Domain=domain" />  
    <add name="CrmOnline" connectionString="Url=https://mydomain.crm.dynamics.com/; Username=someone@mydomain.onmicrosoft.com; Password=password" />  
  </connectionStrings>  

  <appSettings>  
    <!--For information on how to register an app and obtain the ClientId and RedirectUrl  
        values see https://msdn.microsoft.com/dynamics/crm/mt149065 -->  
    <!--Active Directory application registration. -->  
    <!--These are dummy values and should be replaced with your actual app registration values.-->  
    <add key="ClientId" value="e5cf0024-a66a-4f16-85ce-99ba97a24bb2" />  
    <add key="RedirectUrl" value="https://localhost/SdkSample" />  

    <!-- Use an alternate configuration file for connection string and setting values. This optional setting  
    enables use of an app.config file shared among multiple applications. If the specified file does  
    not exist, this setting is ignored.-->  
    <add key="AlternateConfig" value="C:\Temp\crmsample.exe.config"/>  
  </appSettings>

ソリューションを開発または展開している時、実際の接続およびアプリケーションの登録値は例のプレースホルダーの値に対して置換する必要があります。

次のステップ

この時点では、エラーなしでソリューションを作成できます。アプリケーション構成ファイルを編集し、Dynamics 365 Server に対して値を入力する場合は、プログラムがそのサーバーに正常に接続される必要もあります。ソリューションは、Dataverse Web API への呼び出しを含め、カスタムコードを承諾する準備が整っている骨格フレームを表します。

ヒント

このトピックを閉じる前に、プロジェクトテンプレートとしてプロジェクトを保存することを検討します。次に、今後の学習プロジェクトのためにそのテンプレートを再利用すると、新しいプロジェクトの設定の時間と労力を節約できます。このため、プロジェクトが Microsoft Visual Studioでオープンしている間に、 ファイル メニューで、テンプレートのエクスポート を選択します。テンプレートウィザードのエクスポートの指示に従い、テンプレートを作成します。