この記事では、PowerShell を使用した WebAPI サンプルに関する一般的な理解を提供します。 各サンプルでは、Microsoft Dataverse Web API のさまざまな側面に焦点を当てていますが、これらはすべて、この記事で説明する同様のプロセスと構造に従います。
PowerShell を使用した Web API サンプル
次のサンプルは、ここで説明されるパターンを使用します:
| サンプル | サンプル グループ | 説明 |
|---|---|---|
| Web API の基本的な操作のサンプル (PowerShell) | Web API 基本操作のサンプル | Dataverse テーブル行 (エンティティ レコード) の作成、取得、更新、削除、関連付け、および関連付け解除の各操作を実行する方法を説明します。 |
| Web API クエリ データ サンプル (PowerShell) | Web API クエリ データのサンプル | OData v4 クエリ構文と機能および Dataverse クエリ機能を使用する方法を説明します。 定義済みクエリに関する作業の例を含み、FetchXML を使用してクエリを実行します。 |
| Web API の条件付き操作のサンプル (PowerShell) | Web API の条件付き操作のサンプル | ETag の条件を指定する条件付き演算の実行方法を示します。 |
| Web API の関数とアクションのサンプル (PowerShell) | Web API 機能およびアクションのサンプル | バインドされた関数とバインドされていない関数とアクション (カスタム アクションを含む) を使用する方法を示します。 |
| Web API テーブル スキーマ操作サンプル (PowerShell) | Web API テーブル スキーマ操作のサンプル | Dataverse スキーマまたはメタデータを変更する選択した演算の実行方法を示します。 |
前提条件
これらのサンプルを実行する前に、これらのサンプルで使用される概念とパターンについて説明した次の記事を読む必要があります。
- PowerShell と Visual Studio Code を使用して Web API を迅速に開始するためのガイド
- Dataverse Web API で PowerShell と Visual Studio Code を使用する
これらのサンプルには同じ前提条件があります。
以下をインストールするか、インストールされていることを確認する
Visual Studio Code をインストールします。 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を使います
インストールの確認
Visual Studio Codeを開く。
[ ターミナル ] メニューの [ 新しいターミナル] を選択します。
Visual Studio Code ナビゲーション ウィンドウで、PowerShell 拡張子の
アイコンを選択します。Visual Studio Code ターミナル ウィンドウで、次のスクリプトをコピーして貼り付けます。
Write-Host 'PowerShell Version:'$PSVersionTable.PSVersion.ToString() Write-Host 'PowerShell Az version:'(Get-InstalledModule Az).VersionEnter キーを押します。 出力は次のようになります。
PowerShell Version: 7.4.0 PowerShell Az version: 11.1.0
このような結果が表示されない場合は、前提条件をインストールまたは更新してください。
さらに必要なこと
- Dataverse 環境に有効なユーザー アカウント
- 接続に使用したい Dataverse 環境への URL。 検索方法については、開発者向けリソースを表示 をご覧ください。 次のようになります:
https://yourorg.crm.dynamics.com/、これはyourorg.crmが異なります。 - PowerShell スクリプト言語の基本的な解釈
参照
Dataverse Web API を使用する
PowerShell と Visual Studio Code を使用して Web API を迅速に開始するためのガイド
Dataverse Web API で PowerShell と Visual Studio Code を使用する
Web API サンプル