Cmdlets for Microsoft Dynamics CRM

Build 24.0.9062

接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でDynamicsCRM Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。 

Install-Module DynamicsCRMCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。 

Import-Module DynamicsCRMCmdlets;

Connect-DynamicsCRM cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。 

$conn = Connect-DynamicsCRM -CRMVersion "CRM2011+" -Url "http://MySite/MyOrganization" -User "MyUser" -Password "MyPassword"

Microsoft Dynamics CRM への接続

接続するには、組織のルートURL を設定します。

Microsoft Dynamics CRM オンプレミスへの認証

Microsoft Dynamics CRM オンプレミスへの認証を行うには、CRMVersion = CRM2011+ を設定します。

NTLM

CRM オンプレミスのデプロイでNTLM 認証を介したSPNEGO を使用するには、以下のパラメータを設定します。

  • AuthScheme：NTLM。
  • User：ユーザーのログインId。
  • Password：ユーザーのログインパスワード。

NTLM 接続文字列の例： 

AuthScheme=NTLM;Url='https://myOrg.crm.dynamics.com/';User=username;Password=password;CRM Version='CRM2011+'

Kerberos

CRM オンプレミスのデプロイでKerberos 認証を介したSPNEGO を使用するには、以下のパラメータを設定します。

  • AuthScheme：Kerberos。
  • User：ユーザーのログインId。
  • Password：ユーザーのログインパスワード。

Kerberos 接続文字列の例： 

AuthScheme=Kerberos;Url='https://myOrg.crm.dynamics.com/';User=username;Password=password;CRM Version='CRM2011+'

Internet-Facing Deployment（IFD）

IFD 経由で認証するには、InternetFacingDeployment をtrue に設定します。

IFD 接続文字列の例： 

AuthScheme=NTLM;Url='https://myOrg.com/';User=username;Password=password;InternetFacingDeployment=True;CRM Version='CRM2011+'

Microsoft Dynamics CRM オンラインへの認証

Azure AD（ユーザーベースの認証）またはAzure サービスプリンシパル（サービス プリンシパルベースの認証）のいずれかを使用して、Microsoft Dynamics CRM オンラインへの認証を行うことができます。

Microsoft Dynamics CRM オンラインへの認証を行うには、CRMVersion = CRMOnline を設定します。

Azure AD

Azure AD は、Microsoft のマルチテナント、クラウドベースのディレクトリおよびID 管理サービスです。これはユーザーベースの認証で、AuthScheme をAzureAD に設定する必要があります。

Web アプリケーションを介したAzure AD への認証には、必ずカスタムOAuth アプリケーションの作成が必要です。詳細はAzure AD アプリケーションの作成 を参照してください。

デスクトップアプリケーション

CData は、デスクトップアプリケーションからAzure AD への接続を簡略化する埋め込みOAuth アプリケーションを提供します。

カスタムOAuth アプリケーションを使用して、デスクトップアプリケーションで認証することもできます。（詳しくは、Azure AD アプリケーションの作成 を参照してください。） Azure AD 経由で認証するには、以下のパラメータを設定します。

  • AuthScheme：AzureAD。

  • カスタムアプリケーションのみ：

    • OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
    • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
    • CallbackURL：カスタムOAuth アプリケーションの登録時に定義したリダイレクトURI。

接続すると、本製品 はデフォルトブラウザでMicrosoft Dynamics CRM のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

本製品 はOAuth プロセスを完了し、Microsoft Dynamics CRM からアクセストークンを取得してそれを使ってデータをリクエストします。 OAuth 値はOAuthSettingsLocation で指定されたパスに保存されます。これらの値は接続間で永続化されます。

アクセストークンの期限が切れたときは、本製品 は自動でアクセストークンをリフレッシュします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

以下のいずれかの方法で行います。

  • 後述のオプション1：Verifier code を取得および交換に従い、OAuthVerifier 値を取得します。
  • 後述のオプション2：OAuth 設定を転送で説明するように、本製品 を別のマシンにインストールします。通常のブラウザベースのフローで認証した後、OAuth 認証値を転送します。

オプション1：Verifier code を取得および交換

  1. 認可エンドポイントを見つけます。

    カスタムアプリケーションのみ： 次のプロパティを設定して、Authorization URL を作成します。

    • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
    • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

    カスタムアプリケーションおよび埋め込みアプリケーション：GetOAuthAuthorizationUrl ストアドプロシージャを呼び出します。

    1. ストアドプロシージャによって返されたURL をブラウザで開きます。
    2. ログインして、本製品 にアクセス許可を与えます。verifier code を含むコールバックURL にリダイレクトされます。
    3. verifier code の値を保存します。この値は後でOAuthVerifier 接続プロパティを設定する際に使用します。

  2. OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。

    ヘッドレスマシンでは、次のプロパティを設定します。

    • AuthScheme：AzureAD。
    • OAuthVerifier：verifier code。
    • OAuthSettingsLocation：接続間で維持されるOAuth トークンの値を保存するファイルの場所。

    • カスタムアプリケーションのみ：

      • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
      • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。

  3. OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットします。

    • OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

    • カスタムアプリケーションのみ：

      • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
      • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

オプション2：OAuth 設定を転送

ヘッドレスマシン経由の接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順を完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンでは、次のプロパティを設定します。

  • AuthScheme：AzureAD。
  • OAuthSettingsLocation：OAuth 設定ファイルの場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

  • カスタムアプリケーションのみ：

    • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId。
    • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレット。

Azure サービスプリンシパル

サービスプリンシパルは、Azure AD アプリケーション内のセキュリティオブジェクトであり、特定のAzure AD テナント内でそのアプリケーションができることを定義します。 サービスプリンシパルは、Azure サービスポータルで作成します。 作成プロセスの過程で、サービスプリンシパルがクライアントシークレットまたは証明書のどちらを経由してAzure AD リソースにアクセスするかも指定します。

サービスプリンシパルの権限は、特定のユーザーに紐づくのではなく、割り当てられたロールに基づきます。 リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

Azure サービスプリンシパルを使用して認証する場合、サービスプリンシパルによるAzure AD アプリケーションの作成 で説明するようにAzure AD テナントにアプリケーションを登録する必要があります。

次のサブセクションで説明するプロパティを設定すれば、接続の準備は完了です。これらは、クライアントシークレットで認証するか、証明書で認証するかによって異なります。

クライアントシークレットによる認証

  • AuthScheme：AzureServicePrincipal。
  • AzureTenant：接続するAzure AD テナント。
  • OAuthGrantType：CLIENT。
  • OAuthClientId：アプリケーション設定のクライアントId。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレット。

証明書による認証

  • AuthScheme：AzureServicePrincipalCert。
  • AzureTenant：接続するAzure AD テナント。
  • OAuthGrantType：CLIENT。
  • OAuthClientId：アプリケーション設定のクライアントId。
  • OAuthJWTCert：JWT 証明書のストア。
  • OAuthJWTCertType：JWT 証明書ストアの種類。

データの取得

Select-DynamicsCRM cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。 

$results = Select-DynamicsCRM -Connection $conn -Table "Lead" -Columns @("Id, FirstName") -Where "FirstName='Bob'"
Invoke-DynamicsCRM cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。 

Select-DynamicsCRM -Connection $conn -Table Lead -Where "FirstName <> 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myLeadData.csv -NoTypeInformation

Select-DynamicsCRM からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。 

 
PS C:\> $conn  = Connect-DynamicsCRM -CRMVersion "CRM2011+" -Url "http://MySite/MyOrganization" -User "MyUser" -Password "MyPassword"
PS C:\> $row = Select-DynamicsCRM -Connection $conn -Table "Lead" -Columns (Id, FirstName) -Where "FirstName <> 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Lead",
  "Columns":  [

  ],
  "Id":  "MyId",
  "FirstName":  "MyFirstName"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。 

Select-DynamicsCRM -Connection $conn -Table Lead -Where "FirstName = 'Bob'" | Remove-DynamicsCRM

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをMicrosoft Dynamics CRM にロードします。 

Import-Csv -Path C:\MyLeadUpdates.csv | %{
  $record = Select-DynamicsCRM -Connection $conn -Table Lead -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-DynamicsCRM -Connection $conn -Table Lead -Columns @("Id","FirstName") -Values @($_.Id, $_.FirstName) -Where "Id  = `'$_.Id`'"
  }else{
    Add-DynamicsCRM -Connection $conn -Table Lead -Columns @("Id","FirstName") -Values @($_.Id, $_.FirstName)
  }
}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062