Web API 基本操作のサンプル (PowerShell)

  • [アーティクル]

この PowerShell バージョン 7.4.0 サンプルは、 Dataverse Web API と Visual Studio Code を使用して一般的なデータ操作を実行する方法を示します。 このサンプルは、Dataverse 操作と Web API Basic 操作サンプル で説明されているコンソール出力を実装します。

このサンプルでは、​ Dataverse Web API PowerShell ヘルパー関数 を使用して認証を管理し、一般的な操作を実行するための再利用可能な関数を提供します。 これらのスクリプトは、次の行で ドット ソーシング を使用して参照されます。

. $PSScriptRoot\..\Core.ps1
. $PSScriptRoot\..\TableOperations.ps1
. $PSScriptRoot\..\CommonFunctions.ps1

注意

このサンプルは Windows、Linux、macOS で動作するはずですが、Windows でのみテストされています。

前提条件

このサンプルを実行する前に、これらのサンプルで使用される概念とパターンについて説明した次の記事を読む必要があります。

これらの記事には同じ前提条件があります。

以下をインストールするか、インストールされていることを確認する

インストールを検証する

  1. Visual Studio Code を開きます。

  2. ターミナル メニューで、新規ターミナル を選択します。

  3. Visual Studio Code ナビゲーション ウィンドウで、PowerShell 拡張子の アイコンを選択します。

  4. Visual Studio Code ターミナル ウィンドウで、次のスクリプトをコピーして貼り付けます。

    Write-Host 'PowerShell Version:'$PSVersionTable.PSVersion.ToString()
Write-Host 'PowerShell Az version:'(Get-InstalledModule Az).Version

  5. Enter キーを押します。 出力は、次の例のようになります。

    PowerShell Version: 7.4.0
PowerShell Az version: 11.1.0

このような結果が表示されない場合は、前提条件をインストールまたは更新してください。

さらに必要なこと

  • Dataverse 環境に有効なユーザー アカウント
  • 接続に使用したい Dataverse 環境への URL。 検索方法については、開発者向けリソースを表示 をご覧ください。 次のようになります: https://yourorg.crm.dynamics.com/、これは yourorg.crm が異なります。
  • PowerShell スクリプト言語の基本的な解釈

このサンプルを実行する方法

  1. PowerApps-サンプル リポジトリをクローンまたはダウンロードします。

  2. Visual Studio Code を使用して BasicOperations.ps1 ファイルを開く

  3. この行を編集して、接続したい環境の URL を使用します。

    Connect 'https://yourorg.crm.dynamics.com/' # change this

  4. (オプション) このサンプルが作成するレコードを削除したくない場合は、$deleteCreatedRecords 変数を $false に設定します。

  5. F5 を押してサンプルを実行します。

  6. サンプルを初めて実行すると、ブラウザ ウィンドウが開きます。 ブラウザ ウィンドウで、認証に使用する資格情報を入力または選択します。

別のユーザーとして接続するには、Disconnect-AzAccount コマンド を実行して、再試行してください。

コード

このサンプルのコードはこちらにあります: PowerApps-Samples/dataverse/webapi/PS/BasicOperations/BasicOperations.ps1

実際の動作

このサンプルには 5 つのリージョンがあります。

セクション 1: 基本的な演算の作成および更新

演算:

  • 取引先担当者レコードを作成します。
  • 取引先担当者レコードを更新します。
  • 取引先担当者レコードを取得します。
  • 取引先担当者レコードの 1 つのプロパティを更新します。
  • 取引先担当者レコードの 1 つのプロパティを取得します。

セクション 2: 別のレコードに関連付けられたレコードの作成

演算: 新しいレコードを既存のレコードに関連付けます。

演算: 1 つの演算で次のエントリを作成します: アカウント、関連付けられた取引先責任者、その責任者のオープン タスク。 これらのエンティティ型には、次のリレーションシップ があります:

Accounts
    |---[Primary] Contact (N-to-1)
        |---Tasks (1-to-N)

セクション 4: レコードの関連付けと関連付け解除

演算:

  • 取引先企業 contact_customer_accounts コレクションに取引先担当者を追加します。
  • 取引先企業 contact_customer_accounts コレクションから取引先担当者を削除します。
  • systemuserroles_association コレクションを使用してセキュリティ ロールをユーザーに関連付けます。
  • systemuserroles_association コレクションを使用してユーザーのセキュリティ ロールを削除します。

セクション 5: サンプル レコードを削除

操作: このサンプルで作成された各レコードへの参照は、作成時にリストに追加されました。 このセクションでは、そのリストをループし、各レコードを削除します。

クリーンアップ

デフォルトでは、このサンプルでは作成されたすべてのレコードが削除されます。 サンプルの完了後に作成されたレコードを表示したい場合は、deleteCreatedRecords 変数を false に変更して、レコードを削除するかどうかを決定するプロンプトが表示されます。

参照

Dataverse Web API の使用
PowerShell と Visual Studio Code を使った Web API のクイックスタート
Dataverse Web API で PowerShell と Visual Studio Code を使う
Web API を使用してテーブル行を作成する
Web API を使用したテーブル行の更新と削除
Web API を使用してテーブルの行を取得する
Web API のサンプル
Web API Operations 操作のサンプル

注意

ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。