XRM ツールの接続文字列を使用して Microsoft Dataverse に接続する

Dataverse では、XRM ツールは接続文字列を使用することで、Dataverse の環境に接続することができます。 これは SQL Server で使用される接続文字列の概念と似ています。 接続文字列は、最大限のセキュリティを得るために構成セクションを暗号化する機能を含むネイティブ サポートを、構成ファイルに備えています。 これにより、Dataverse 環境に接続する際に、使用しているアプリケーションにハード コーディングしない Dataverse 接続を展開時に構成することができます。

接続文字列の作成

以下の例のように、この接続文字列をプロジェクトの app.config または web.config ファイルで指定します。

<connectionStrings>  
    <add name="MyCDSServer" connectionString="AuthType=OAuth;Username=jsmith@contoso.onmicrosoft.com;Password=passcode;Url=https://contosotest.crm.dynamics.com;AppId=51f81489-12ee-4a9e-aaae-a2591f45987d;RedirectUri=app://58145B91-0C36-4500-8554-080854F2AC97;TokenCacheStorePath=c:\MyTokenCache;LoginPrompt=Auto"/>
</connectionStrings>  

接続文字列を作成したら、それを使用して CrmServiceClient オブジェクトを作成します。

//Use the connection string named "MyCDSServer"  
//from the configuration file  
CrmServiceClient svc = new CrmServiceClient(ConnectionString);  

あるいは、ServiceClient クラスを使用することもできます。

ServiceClient svc = new ServiceClient(ConnectionString);  

サービス クライアント オブジェクトを作成した後、そのオブジェクトを使用して Dataverse でアクションを実行することができます。 詳細: XRM ツールを使用して Dataverse のアクションを実行する

接続文字列パラメーター

接続文字列には、セミコロンで区切られた一連の名前=値の組が含まれまています。 次の表は、任意の受注で入力できる、サポートされるパラメーターを一覧表示しています。

接続文字列の例

次の例は、online の展開および認証シナリオに接続するための接続文字列の使用方法を示しています。 設置型および IFD 展開インスタンスの接続文字列の例は、次に示す Dynamics 365 Customer Engagement (on-premises) ドキュメントで入手可能になりました: XRM ツールで接続文字列を使用して Customer Engagement に接続する

Office365 を使用した名前付き取引先企業

Office365 でユーザー名またはパスワードを使用して Dataverse への新しい接続を作成します。

<add name="MyCDSServer" 
 connectionString="
  AuthType=Office365;
  Username=jsmith@contoso.onmicrosoft.com; 
  Password=passcode;
  Url=https://contoso.crm.dynamics.com"/>  

認証のプロンプトに Microsoft 365 で UX と一緒に取引先企業を使用している OAuth

OAuth 経由で UserId またはパスワードを使用する Dataverse に新規に接続します。

<add name="MyCDSServer"
 connectionString="
  AuthType=OAuth;
  Username=jsmith@contoso.onmicrosoft.com;
  Password=passcode;
  Url=https://contosotest.crm.dynamics.com;
  AppId=51f81489-12ee-4a9e-aaae-a2591f45987d;
  RedirectUri=app://58145B91-0C36-4500-8554-080854F2AC97;
  TokenCacheStorePath=c:\MyTokenCache;
  LoginPrompt=Auto"/>  

フォールバック UX で現在ログインしているユーザーを使用して認証を求める OAuth

OAuth 経由で現在ログインしているユーザーを使用して Dataverse への新しい接続を作成します。

<add name="MyCDSServer"
 connectionString="
  AuthType=OAuth;
  Username=jsmith@contoso.onmicrosoft.com;
  Integrated Security=true;
  Url=https://contosotest.crm.dynamics.com;
  AppId=51f81489-12ee-4a9e-aaae-a2591f45987d;
  RedirectUri=app://58145B91-0C36-4500-8554-080854F2AC97;
  TokenCacheStorePath=c:\MyTokenCache\msal_cache.data;
  LoginPrompt=Auto"/>  

クレームベース認証

アプリケーションまたはクライアント ID と証明書を使用して、Dataverse への新しい接続を作成します。

<add name="MyCDSServer" 
  connectionString="
  AuthType=Certificate;
  url=https://contosotest.crm.dynamics.com;
  thumbprint={CertThumbPrintId};
  ClientId={AppId};"
  />

ClientId またはクライアント シークレット ベースの認証

アプリケーションまたはクライアント ID とクライアント シークレットを使用して、Dataverse への新しい接続を作成します。

<add name="MyCDSServer" 
  connectionString="
  AuthType=ClientSecret;
  url=https://contosotest.crm.dynamics.com;
  ClientId={AppId};
  ClientSecret={ClientSecret}"
  />

接続状態を決定する

接続要求が成功したかどうかを決定するには、CrmServiceClientIsReady プロパティ。 true の場合、接続が成功し、実行する準備ができています。 それ以外の場合は、接続失敗の原因として、CrmServiceClient.LastCrmError および CrmServiceClient.LastCrmException プロパティの値を確認します。

関連項目

XRM ツールを使用して Windows のクライアント アプリケーションを作成する
CrmServiceClient コンストラクターを使用して Dataverse に接続
XRM ツールを使用して Dataverse でアクションを実行
CrmServiceClient