次の方法で共有

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

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

GitHub でこのサンプルを表示する

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

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

注意

このサンプルは、Windows、Linux、および macOS で動作する必要がありますが、Windowsでのみテストされています。

前提条件

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

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

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

  • Visual Studio Codeをインストールします。 「Download Visual Studio Code

  • Visual Studio Code用の PowerShell 拡張機能をインストールします。 「Visual Studio Code 用 PowerShell」を参照してください。

  • PowerShell 7.4以上をインストールします。 Windows、Linux、および macOS に PowerShell をインストールする

  • Az PowerShell モジュール バージョン 11.1.0 以降をインストールします。 Azure PowerShell

    既存のインストールを最新のバージョンに更新 するには、Update-Module -Name Az -Force を使います

インストールを検証する

  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 コマンド を実行して、再試行してください。

Code

このサンプルのコードはこちらにあります: 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 を使用してテーブル行を更新および削除する
WebAPI を使用してテーブル行を取得する
Web API サンプル
Web API 基本操作のサンプル

  • Last updated on