MENU
  1. ホーム
  2. PowerShell
  3. PowerShellでMicrosoft Dataverse環境を構築しアプリ基盤を整える方法

PowerShellでMicrosoft Dataverse環境を構築しアプリ基盤を整える方法

PowerShell

PowerShellを活用してMicrosoft Dataverse（旧Common Data Service: CDS）環境を構築し、アプリケーション基盤を整える方法を解説します。Dataverseは、データの統合・管理を容易にするMicrosoft Power Platformの中核を担うデータストレージサービスであり、企業の業務アプリケーションの基盤として利用されます。

手動でDataverse環境を作成することも可能ですが、PowerShellを活用すれば、スクリプトによる自動化や環境の一括管理が可能となり、大規模運用やDevOpsにおいて非常に有用です。本記事では、Dataverse環境の基礎知識を押さえたうえで、PowerShellを用いた環境構築の具体的な手順を紹介します。さらに、データ管理やセキュリティ設定、APIとの連携方法、トラブルシューティングについても詳しく解説します。

PowerShellを駆使してDataverse環境を構築し、業務アプリケーションの基盤を効率的に整えましょう。

目次
  1. Microsoft Dataverseとは？
    1. Dataverseの主な特徴
    2. Dataverseの活用シーン
    3. Dataverseのメリット
  2. PowerShellでDataverse環境を構築するメリット
    1. 1. GUI操作と比較したPowerShellの利点
    2. 2. スクリプトによる自動化の重要性
    3. 3. DevOpsとの統合
    4. 4. まとめ
  3. PowerShellでのDataverse管理に必要なツール
    1. 1. Power Platform CLI（pac CLI）
    2. 2. Microsoft PowerShellモジュール（Microsoft.PowerPlatform）
    3. 3. Azure Active Directory (Azure AD) 認証
    4. 4. Dataverse Web API
    5. 5. まとめ
  4. PowerShellを使ったDataverse環境の作成手順
    1. 1. PowerShell環境の準備
    2. 2. PowerShellでDataverse環境にログイン
    3. 3. Dataverse環境の作成
    4. 4. Dataverse環境の詳細設定
    5. 5. 環境の削除（オプション）
    6. 6. まとめ
  5. Dataverseテーブルの作成とデータ管理
    1. 1. Dataverseのテーブルとは？
    2. 2. PowerShellを使ったDataverseテーブルの作成
    3. 3. テーブルへの列（カラム）の追加
    4. 4. Dataverseのテーブルにデータを追加
    5. 5. Dataverseのテーブルデータを取得
    6. 6. Dataverseのテーブルデータを更新
    7. 7. Dataverseのテーブルデータを削除
    8. 8. まとめ
  6. Dataverseの権限管理とセキュリティ設定
    1. 1. Dataverseの権限管理の基本
    2. 2. PowerShellを使ったユーザーの追加
    3. 3. セキュリティロールの割り当て
    4. 4. チームを作成し、ユーザーを一括管理
    5. 5. ビジネスユニットを活用したアクセス制御
    6. 6. フィールドレベルセキュリティの設定
    7. 7. まとめ
  7. Dataverse APIを活用した拡張と自動化
    1. 1. Dataverse APIの概要
    2. 2. Dataverse APIの認証（OAuth 2.0）
    3. 3. Dataverse APIを使ったデータ操作
    4. 4. Dataverse APIとPower Automateの連携
    5. 5. Dataverse APIの応用例
    6. 6. まとめ
  8. トラブルシューティングとよくあるエラー対策
    1. 1. PowerShellでDataverse環境に接続できない
    2. 2. Dataverse APIを使用した際の認証エラー
    3. 3. Dataverseテーブル作成時のエラー
    4. 4. PowerShellでレコードの追加ができない
    5. 5. セキュリティロールの適用ができない
    6. 6. Dataverseのデータ取得時のパフォーマンス問題
    7. 7. 環境の削除ができない
    8. 8. まとめ
  9. まとめ

Microsoft Dataverseとは？


Microsoft Dataverse（旧Common Data Service: CDS）は、Microsoft Power Platformの一部として提供されるデータストレージおよび管理基盤です。Dataverseは、さまざまなアプリケーションと統合しやすく、データの一元管理が可能な柔軟なデータ基盤を提供します。

Dataverseの主な特徴


Dataverseは、以下のような特徴を持っています。

  • データの統一管理：アプリケーションごとに異なるデータベースを用意するのではなく、Dataverseを利用することで一元的なデータ管理が可能になります。
  • Microsoft Power Platformとの統合：Power Apps、Power Automate、Power BIなどとシームレスに連携し、ビジネスプロセスの自動化や可視化が容易になります。
  • セキュリティとアクセス制御：ユーザーの権限設定やロール管理により、適切なアクセス制御を実施できます。
  • クラウドベースのデータストレージ：Azureを基盤としたクラウドサービスであるため、可用性やスケーラビリティに優れています。

Dataverseの活用シーン


Dataverseは、企業の業務アプリケーションのデータ基盤として活用され、以下のような場面で使用されます。

  • 顧客管理（CRM）：顧客データや取引情報を一元管理し、Power Appsを活用して営業支援システムを構築。
  • ワークフローの自動化：Power Automateと連携し、データの自動更新や承認フローを構築。
  • BIツールとの統合：Power BIを用いてデータの可視化や分析を行い、意思決定をサポート。
  • カスタムアプリケーションのデータ基盤：独自の業務アプリケーションをPower Appsで作成し、Dataverseをデータソースとして利用。

Dataverseのメリット


Dataverseを利用することで、以下のメリットが得られます。

  • データの一元管理により、業務の効率化が可能
  • 低コード／ノーコードでのアプリ開発が容易
  • Microsoft 365やAzureサービスとの連携がスムーズ
  • セキュリティとコンプライアンスに対応したデータ管理が可能

Microsoft Dataverseは、企業のデータ管理の中核となるソリューションとして多くの企業で導入が進んでいます。本記事では、PowerShellを活用してDataverse環境を構築し、より効率的に管理する方法について詳しく解説していきます。

PowerShellでDataverse環境を構築するメリット

Microsoft Dataverseの環境を構築する方法には、GUIを使用する方法と、PowerShellを活用する方法があります。PowerShellを利用すると、スクリプトを活用した効率的な環境構築や管理が可能となり、大規模なシステム運用にも適しています。本章では、PowerShellを用いてDataverse環境を構築するメリットについて解説します。

1. GUI操作と比較したPowerShellの利点


通常、Dataverse環境はPower Platform管理センターを使用して手動で作成できますが、PowerShellを使用することで以下の利点があります。

  • 自動化が可能
    PowerShellスクリプトを使用することで、環境作成や設定の適用を自動化できます。これにより、繰り返しの手動操作を削減し、作業の効率化を図ることができます。
  • 一括処理ができる
    例えば、複数のDataverse環境を作成する必要がある場合、GUIでは1つずつ手動で作成する必要がありますが、PowerShellを使用すればスクリプトを実行するだけで複数の環境を一括作成できます。
  • 環境の再現性が高い
    スクリプトを保存しておくことで、同じ環境を再現することが容易になります。開発・テスト環境のセットアップなどで非常に有効です。
  • 運用管理の負担軽減
    PowerShellを活用することで、環境のバックアップや設定の変更などの管理業務を効率化できます。特に、環境のライフサイクル管理（作成・更新・削除）を一元管理できます。

2. スクリプトによる自動化の重要性


PowerShellを利用することで、Dataverse環境の作成や設定の適用をスクリプトで自動化できます。以下のようなタスクをスクリプト化することで、手間を削減できます。

  • Dataverse環境の作成
  • 環境設定の適用（言語設定、データベース作成など）
  • ユーザーの追加と権限設定
  • API連携のためのアクセス許可の設定
  • 定期的な環境のバックアップ・削除

スクリプトの例（Dataverse環境の作成）

# Power Platform CLI を使用した Dataverse 環境作成
$environmentName = "MyDataverseEnv"
$region = "us"
$organizationName = "myorg"

pac admin create-environment --name $environmentName --location $region --organization-name $organizationName --type Sandbox

このようなスクリプトを活用すれば、毎回手作業で環境を作成する必要がなくなります。

3. DevOpsとの統合


PowerShellは、CI/CDパイプラインの一部としても活用できます。例えば、Azure DevOpsやGitHub Actionsと組み合わせることで、Dataverse環境の作成やデプロイを自動化し、運用負担を軽減できます。

4. まとめ


PowerShellを活用してDataverse環境を構築することで、自動化や一括処理による効率化が可能になります。手動操作に頼らず、スクリプトを活用することで、環境の再現性や管理の容易さが向上し、大規模な運用にも適用可能です。次章では、Dataverse環境の構築に必要なツールについて詳しく解説します。

PowerShellでのDataverse管理に必要なツール

PowerShellを活用してMicrosoft Dataverse環境を構築・管理するためには、いくつかのツールやモジュールが必要です。本章では、Dataverseを管理する際に必要なツールとそのインストール方法について解説します。

1. Power Platform CLI（pac CLI）

Power Platform CLI（通称 pac CLI）は、Microsoft Power Platformの環境をコマンドラインで管理するためのツールです。Dataverseの環境作成やテーブル管理、ソリューションの展開などが可能です。

インストール方法

WindowsのPowerShellで以下のコマンドを実行し、pac CLI をインストールします。

winget install Microsoft.PowerPlatform

または、公式サイト からダウンロードしてインストールすることも可能です。

主なコマンド

# Dataverse環境の一覧を取得
pac admin list

# 新しいDataverse環境を作成
pac admin create-environment --name "MyDataverseEnv" --location "us" --type Sandbox

# Dataverse環境の削除
pac admin delete-environment --id "環境ID"

pac CLI を使用することで、Dataverse環境の作成・管理をスクリプト化でき、自動化が容易になります。

2. Microsoft PowerShellモジュール（Microsoft.PowerPlatform）

PowerShellには、Dataverseの環境管理やデータ操作を行うためのモジュール Microsoft.PowerPlatform も提供されています。このモジュールを利用することで、DataverseのリソースをPowerShellスクリプトで管理できます。

インストール方法

以下のコマンドを実行して、Power Platform管理用のPowerShellモジュールをインストールします。

Install-Module -Name Microsoft.PowerPlatform -Scope CurrentUser

インストール後、以下のコマンドでモジュールをインポートします。

Import-Module Microsoft.PowerPlatform

主なコマンド

# Dataverse環境へ接続
Connect-AdminPowerPlatform

# すべてのDataverse環境を一覧表示
Get-AdminPowerPlatformEnvironment

# Dataverse環境を削除
Remove-AdminPowerPlatformEnvironment -EnvironmentName "MyDataverseEnv"

このモジュールを活用すれば、Dataverse環境をPowerShellスクリプトで直接操作できるようになります。

3. Azure Active Directory (Azure AD) 認証

Dataverseの環境をPowerShellで管理するためには、Azure Active Directory（Azure AD）の認証が必要です。Azure ADを活用することで、アクセス権の管理や認証の自動化が可能になります。

Azure AD モジュールのインストール

Install-Module -Name AzureAD -Scope CurrentUser

DataverseにAzure ADで接続

Connect-AzureAD

Azure ADと統合することで、PowerShellを使用したセキュアな環境管理が実現できます。

4. Dataverse Web API

Dataverse Web API を利用すると、REST API経由でDataverse環境を管理できます。PowerShellスクリプトからAPIを実行することで、より柔軟な操作が可能になります。

Dataverse Web APIのエンドポイントの例

https://yourorg.api.crm.dynamics.com/api/data/v9.1/

PowerShellでDataverse APIを実行する例：

$accessToken = "取得したアクセストークン"
$headers = @{
    "Authorization" = "Bearer $accessToken"
    "Content-Type" = "application/json"
}

$url = "https://yourorg.api.crm.dynamics.com/api/data/v9.1/accounts"
$response = Invoke-RestMethod -Uri $url -Headers $headers -Method Get
$response.value

Dataverse APIを活用することで、PowerShellスクリプトを使用した高度な自動化が可能になります。

5. まとめ

Dataverse環境をPowerShellで管理するためには、以下のツールを活用します。

  • Power Platform CLI（pac CLI）：Dataverse環境の作成・管理
  • Microsoft PowerShellモジュール（Microsoft.PowerPlatform）：PowerShellスクリプトで環境管理
  • Azure Active Directory（Azure AD）：セキュリティ認証の管理
  • Dataverse Web API：APIを使用した高度なデータ操作

これらのツールを組み合わせることで、Dataverseの環境構築・管理を効率化できます。次章では、実際にPowerShellを用いてDataverse環境を作成する手順を解説します。

PowerShellを使ったDataverse環境の作成手順

PowerShellを活用すると、Dataverse環境の作成をスクリプトで自動化し、GUI操作よりも効率的に環境を構築できます。本章では、Power Platform CLI（pac CLI）を使用して、Dataverse環境を作成する具体的な手順を解説します。

1. PowerShell環境の準備

まず、PowerShellでDataverse環境を管理するためのツールをインストールします。

必要なツールのインストール

# Power Platform CLI のインストール（Winget を使用）
winget install Microsoft.PowerPlatform

# PowerShell モジュールのインストール
Install-Module -Name Microsoft.PowerPlatform -Scope CurrentUser

# Azure AD モジュールのインストール（認証用）
Install-Module -Name AzureAD -Scope CurrentUser

これらのツールをインストールすることで、PowerShellを使ってDataverse環境を作成・管理できるようになります。

2. PowerShellでDataverse環境にログイン

Dataverse環境の作成には、Microsoft Power Platform管理者として認証する必要があります。以下のコマンドを実行して、PowerShellからDataverseに接続します。

# Power Platform CLI で認証
pac auth create --url https://admin.powerplatform.microsoft.com

または、PowerShellモジュールを使用する場合：

Connect-AdminPowerPlatform

認証が完了すると、Dataverse環境を作成できるようになります。

3. Dataverse環境の作成

Dataverse環境を作成するには、Power Platform CLIの pac admin create-environment コマンドを使用します。

Dataverse環境を作成するコマンド

# 環境名、リージョン、種類を指定して作成
$environmentName = "MyDataverseEnv"
$region = "us"
$organizationName = "myorg"

pac admin create-environment --name $environmentName --location $region --organization-name $organizationName --type Sandbox
パラメータ説明
--name環境名（MyDataverseEnv など）
--locationデータセンターのリージョン（us, europe など）
--organization-name組織の名前
--type環境の種類（Sandbox または Production）

実行結果の確認

環境作成後、以下のコマンドで作成された環境を一覧表示し、正しく作成されたか確認します。

pac admin list

または、PowerShellモジュールを使用する場合：

Get-AdminPowerPlatformEnvironment

作成した環境が一覧に表示されれば、Dataverse環境が正常に作成されています。

4. Dataverse環境の詳細設定

作成した環境に対して、言語やデータベースを設定します。

言語とデータベースの設定

$environmentId = "環境ID"  # `pac admin list` で取得したIDを指定
pac admin set-settings --environment $environmentId --language "ja-JP"

データベースの作成

pac admin create-database --environment $environmentId --currency "JPY" --language "ja-JP"
パラメータ説明
--currencyデフォルトの通貨設定（USD, JPY など）
--languageデフォルトの言語設定（ja-JP など）

これにより、Dataverse環境にデータベースが作成され、使用可能になります。

5. 環境の削除（オプション）

テスト環境の削除が必要な場合は、以下のコマンドを使用します。

# Dataverse環境を削除
$environmentId = "環境ID"
pac admin delete-environment --id $environmentId

または、PowerShellモジュールを使用する場合：

Remove-AdminPowerPlatformEnvironment -EnvironmentName "MyDataverseEnv"

これにより、不要な環境を削除できます。

6. まとめ

PowerShellを使用すると、Dataverse環境の作成や管理をスクリプトで自動化でき、GUI操作よりも効率的に環境を構築できます。

本章では、

  • PowerShell環境の準備
  • Dataverse環境へのログイン
  • Dataverse環境の作成
  • 言語・データベースの設定
  • 環境の削除（オプション）

といった手順を解説しました。

次章では、作成したDataverse環境にテーブルを作成し、データ管理を行う方法について詳しく解説します。

Dataverseテーブルの作成とデータ管理

Dataverse環境を作成した後は、データを格納するためのテーブル（エンティティ）を作成し、管理する必要があります。PowerShellを利用すると、手動操作を行わずにスクリプトで一括管理できるため、大規模運用に適しています。本章では、Dataverseにテーブルを作成し、データを管理する方法を解説します。

1. Dataverseのテーブルとは？

Dataverseのテーブル（Table） は、データを構造化して保存するためのコンテナです。テーブルには、列（Columns） や データ行（Records） が含まれ、各テーブルはキー（主キー）を持ちます。

例えば、顧客情報を管理するテーブルを作成すると、以下のような構造になります。

顧客ID名前メールアドレス電話番号
001山田 太郎yamada@example.com090-1234-5678
002佐藤 花子sato@example.com080-9876-5432

Dataverseでは、これらのテーブルを管理し、PowerAppsやPower Automateなどのアプリケーションと連携できます。

2. PowerShellを使ったDataverseテーブルの作成

PowerShellを利用してDataverseに新しいテーブルを作成するには、Dataverse Web API または pac CLI（Power Platform CLI） を使用します。

テーブルを作成するPowerShellスクリプト（Web API使用）

# Dataverse API のエンドポイント設定
$accessToken = "取得したアクセストークン"
$headers = @{
    "Authorization" = "Bearer $accessToken"
    "Content-Type" = "application/json"
}

# Dataverse環境のURL（組織URLを指定）
$dataverseUrl = "https://yourorg.api.crm.dynamics.com"

# 新規テーブルの作成
$body = @{
    DisplayName = "顧客情報"
    SchemaName  = "new_CustomerTable"
    Description = "顧客の情報を管理するテーブル"
    PrimaryNameAttribute = "new_CustomerName"
} | ConvertTo-Json -Depth 10

$response = Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/EntityDefinitions" -Method Post -Headers $headers -Body $body
$response
パラメータ説明
DisplayName表示名（ユーザーが見る名前）
SchemaNameスキーマ名（システム内識別名）
PrimaryNameAttribute主キーの名前（例：顧客名）

3. テーブルへの列（カラム）の追加

Dataverseのテーブルには、標準的な列がいくつか含まれますが、必要に応じてカスタム列を追加できます。

列を追加するPowerShellスクリプト（Web API使用）

# 顧客テーブルにメールアドレスの列を追加
$columnBody = @{
    DisplayName = "メールアドレス"
    SchemaName  = "new_Email"
    LogicalName = "new_email"
    AttributeType = "String"
    MaxLength = 255
} | ConvertTo-Json -Depth 10

$response = Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/EntityDefinitions(LogicalName='new_CustomerTable')/Attributes" -Method Post -Headers $headers -Body $columnBody
$response

このスクリプトを実行すると、メールアドレス の列（new_Email）が追加されます。

パラメータ説明
DisplayNameユーザー向けの表示名
SchemaName内部的なスキーマ名
AttributeTypeデータ型（String, Integer, DateTime など）
MaxLength文字列の最大長（Stringの場合）

4. Dataverseのテーブルにデータを追加

作成したテーブルにデータを追加するには、Invoke-RestMethod を使用します。

データの追加

$recordBody = @{
    "new_CustomerName" = "山田 太郎"
    "new_Email" = "yamada@example.com"
} | ConvertTo-Json -Depth 10

$response = Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/new_CustomerTables" -Method Post -Headers $headers -Body $recordBody
$response
パラメータ説明
new_CustomerName顧客名
new_Emailメールアドレス

5. Dataverseのテーブルデータを取得

追加されたデータを取得するには、以下のPowerShellコマンドを使用します。

$response = Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/new_CustomerTables" -Method Get -Headers $headers
$response.value

このスクリプトを実行すると、Dataverseに登録されているすべての顧客情報が取得できます。

6. Dataverseのテーブルデータを更新

登録したデータを更新するには、PATCH メソッドを使用します。

$updateBody = @{
    "new_Email" = "yamada_new@example.com"
} | ConvertTo-Json -Depth 10

$recordId = "対象のレコードID"
$response = Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/new_CustomerTables($recordId)" -Method Patch -Headers $headers -Body $updateBody
$response

このスクリプトを実行すると、指定した顧客のメールアドレスが更新されます。

7. Dataverseのテーブルデータを削除

不要なデータを削除する場合は、DELETE メソッドを使用します。

$recordId = "対象のレコードID"
Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/new_CustomerTables($recordId)" -Method Delete -Headers $headers

これにより、指定したレコードが削除されます。

8. まとめ

PowerShellを活用することで、Dataverseのテーブルを効率的に管理できます。

本章では、

  • Dataverseのテーブルの作成
  • 列の追加
  • データの追加・取得・更新・削除

の手順を解説しました。

次章では、Dataverseの権限管理とセキュリティ設定について詳しく解説します。

Dataverseの権限管理とセキュリティ設定

Microsoft Dataverseでは、データの安全性を確保するために権限管理とセキュリティ設定が重要です。Dataverseの環境に適切なアクセス制御を施すことで、不要なデータアクセスを防ぎ、データの保護を強化できます。本章では、PowerShellを活用してDataverseのセキュリティ設定を行う方法を解説します。

1. Dataverseの権限管理の基本

Dataverseの権限管理は、以下の要素で構成されます。

  • セキュリティロール（Security Roles）
  • ユーザーやチームが特定のリソースに対して持つアクセス権限を定義
  • 例：「システム管理者」「基本ユーザー」「営業担当者」など
  • チーム（Teams）
  • ユーザーをグループ化し、一括で権限を付与できる機能
  • ビジネスユニット（Business Units）
  • 組織内のデータを部門単位で管理し、アクセスを制限する
  • フィールドレベルセキュリティ（Field Security）
  • 特定のフィールドの閲覧、編集、削除を制御する機能

2. PowerShellを使ったユーザーの追加

まず、Dataverse環境に新しいユーザーを追加する方法を紹介します。PowerShellを使用すると、手作業を減らし、複数のユーザーを一括登録できます。

ユーザーを追加するPowerShellスクリプト

$accessToken = "取得したアクセストークン"
$headers = @{
    "Authorization" = "Bearer $accessToken"
    "Content-Type" = "application/json"
}

$dataverseUrl = "https://yourorg.api.crm.dynamics.com"

# 新規ユーザーの追加
$userBody = @{
    "firstname" = "太郎"
    "lastname" = "山田"
    "internalemailaddress" = "yamada@example.com"
} | ConvertTo-Json -Depth 10

$response = Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/systemusers" -Method Post -Headers $headers -Body $userBody
$response

このスクリプトを実行すると、新しいユーザーがDataverse環境に追加されます。

3. セキュリティロールの割り当て

ユーザーをDataverse環境に追加した後は、適切なセキュリティロールを割り当てます。

特定のユーザーに「営業担当者」ロールを割り当てる

$roleId = "対象のロールID"
$userId = "対象のユーザーID"

Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/systemusers($userId)/roleassignments/$roleId" -Method Post -Headers $headers
設定項目説明
userIdユーザーのID（systemusers で取得可能）
roleIdセキュリティロールのID（roles で取得可能）

このスクリプトを実行すると、指定したユーザーに「営業担当者」ロールが割り当てられます。

現在のセキュリティロール一覧を取得

$response = Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/roles" -Method Get -Headers $headers
$response.value

このコマンドを使用すると、Dataverse内で定義されているロール一覧が取得できます。

4. チームを作成し、ユーザーを一括管理

チームを作成し、複数のユーザーを一括で管理することも可能です。

新しいチームを作成

$teamBody = @{
    "name" = "営業チーム"
    "businessunitid@odata.bind" = "/businessunits(ビジネスユニットID)"
} | ConvertTo-Json -Depth 10

$response = Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/teams" -Method Post -Headers $headers -Body $teamBody
$response

このスクリプトを実行すると、新しいチームが作成されます。

チームにユーザーを追加

$teamId = "対象のチームID"
$userId = "対象のユーザーID"

Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/teams($teamId)/members/$userId" -Method Post -Headers $headers

これにより、指定したユーザーがチームに追加されます。

5. ビジネスユニットを活用したアクセス制御

ビジネスユニットを利用すると、組織内のデータを部門単位で管理できます。

ビジネスユニットの作成

$businessUnitBody = @{
    "name" = "営業部"
    "parentbusinessunitid@odata.bind" = "/businessunits(親ビジネスユニットID)"
} | ConvertTo-Json -Depth 10

$response = Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/businessunits" -Method Post -Headers $headers -Body $businessUnitBody
$response

このスクリプトを実行すると、「営業部」という新しいビジネスユニットが作成されます。

ビジネスユニットにユーザーを移動

$businessUnitId = "営業部のID"
$userId = "対象のユーザーID"

$updateBody = @{
    "businessunitid@odata.bind" = "/businessunits($businessUnitId)"
} | ConvertTo-Json -Depth 10

Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/systemusers($userId)" -Method Patch -Headers $headers -Body $updateBody

これにより、指定したユーザーを「営業部」に移動できます。

6. フィールドレベルセキュリティの設定

フィールドレベルセキュリティ（Field Security）を設定すると、特定のフィールドへのアクセス制限が可能です。

特定のフィールドを「閲覧のみ」に設定

$fieldSecurityBody = @{
    "fieldsecurityenabled" = true
} | ConvertTo-Json -Depth 10

Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/attributes(対象のフィールドID)" -Method Patch -Headers $headers -Body $fieldSecurityBody

これにより、特定のフィールドのセキュリティが有効になり、アクセス制限が適用されます。

7. まとめ

PowerShellを活用すると、Dataverseの権限管理とセキュリティ設定を効率的に行えます。

本章では、

  • ユーザーの追加
  • セキュリティロールの割り当て
  • チームの作成
  • ビジネスユニットの活用
  • フィールドレベルセキュリティの設定

を解説しました。

次章では、Dataverse APIを活用した拡張と自動化について詳しく解説します。

Dataverse APIを活用した拡張と自動化

Dataverseには、Web API（REST API）を利用してデータの管理や自動化を行う機能が備わっています。PowerShellとDataverse APIを組み合わせることで、テーブルの管理やデータの自動更新、外部システムとの連携などをスクリプトで実装できます。本章では、Dataverse APIを活用した拡張と自動化の手法について解説します。

1. Dataverse APIの概要

DataverseのAPIは、RESTベースで設計されており、以下のような操作が可能です。

操作説明
データの取得（GET）テーブル内のレコードを取得
データの作成（POST）新しいレコードを追加
データの更新（PATCH）既存のレコードを更新
データの削除（DELETE）指定したレコードを削除

APIのエンドポイントは、Dataverseの環境ごとに異なりますが、一般的に以下のような形式になります。

https://yourorg.api.crm.dynamics.com/api/data/v9.1/

PowerShellを使用すれば、これらのAPIを簡単に呼び出すことができます。

2. Dataverse APIの認証（OAuth 2.0）

Dataverse APIを使用するには、まずOAuth 2.0認証を行い、アクセストークンを取得する必要があります。Azure ADのアプリ登録を利用し、クライアントIDとシークレットを設定します。

PowerShellを使ったトークン取得

$tenantId = "your-tenant-id"
$clientId = "your-client-id"
$clientSecret = "your-client-secret"
$resource = "https://yourorg.api.crm.dynamics.com"

$body = @{
    grant_type = "client_credentials"
    client_id = $clientId
    client_secret = $clientSecret
    resource = $resource
} 

$tokenResponse = Invoke-RestMethod -Uri "https://login.microsoftonline.com/$tenantId/oauth2/token" -Method Post -Body $body
$accessToken = $tokenResponse.access_token

取得した $accessToken をAPIのリクエストヘッダーに設定することで、認証付きでAPIを呼び出せます。

3. Dataverse APIを使ったデータ操作

(1) テーブルのレコードを取得（GET）

$headers = @{
    "Authorization" = "Bearer $accessToken"
    "Content-Type" = "application/json"
}

$url = "https://yourorg.api.crm.dynamics.com/api/data/v9.1/new_CustomerTables"
$response = Invoke-RestMethod -Uri $url -Headers $headers -Method Get
$response.value

このスクリプトを実行すると、new_CustomerTables のすべてのレコードが取得できます。

(2) 新しいデータの追加（POST）

$body = @{
    "new_CustomerName" = "田中 一郎"
    "new_Email" = "tanaka@example.com"
} | ConvertTo-Json -Depth 10

$response = Invoke-RestMethod -Uri "$url" -Headers $headers -Method Post -Body $body
$response

これにより、新しい顧客データがDataverseに追加されます。

(3) 既存のデータを更新（PATCH）

$recordId = "対象のレコードID"
$updateBody = @{
    "new_Email" = "tanaka_new@example.com"
} | ConvertTo-Json -Depth 10

Invoke-RestMethod -Uri "$url($recordId)" -Headers $headers -Method Patch -Body $updateBody

このスクリプトを実行すると、new_Email フィールドの値が更新されます。

(4) レコードの削除（DELETE）

Invoke-RestMethod -Uri "$url($recordId)" -Headers $headers -Method Delete

このスクリプトを実行すると、指定したレコードが削除されます。

4. Dataverse APIとPower Automateの連携

Dataverse APIは、Power Automateと連携することで、自動化をさらに強化できます。例えば、以下のようなフローを作成できます。

  • 顧客データの変更をトリガーにAPIを実行（例：メールを自動送信）
  • Power AutomateでDataverseのデータを取得し、Teamsへ通知
  • 特定の条件でレコードをAPI経由で更新

Power Automateの「カスタムコネクタ」を使用すれば、Dataverse APIとPowerShellスクリプトを連携できます。

5. Dataverse APIの応用例

Dataverse APIを活用すると、さまざまな業務プロセスの自動化が可能になります。

応用例内容
CRMシステムとの統合Dataverseの顧客データをCRMと自動同期
BIツールとの連携Power BI でDataverseのデータをリアルタイムで可視化
カスタム通知の実装Dataverseのデータ更新時にTeamsへ通知

例えば、特定の条件を満たしたデータがDataverseに追加された際に、Teamsへ通知を送るスクリプトを作成できます。

$webhookUrl = "https://teams.microsoft.com/api/webhook-url"

$payload = @{
    text = "新しい顧客が追加されました: 田中 一郎"
} | ConvertTo-Json

Invoke-RestMethod -Uri $webhookUrl -Method Post -Body $payload -Headers @{"Content-Type" = "application/json"}

このスクリプトをPower Automateと組み合わせることで、Dataverseと外部システムの連携が可能になります。

6. まとめ

Dataverse APIを活用すると、PowerShellを使ってデータの操作や自動化が可能になります。

本章では、

  • Dataverse APIの概要
  • APIの認証（OAuth 2.0）
  • データの取得・追加・更新・削除
  • Power Automateとの連携
  • 業務プロセスの自動化

について解説しました。

次章では、Dataverseのトラブルシューティングとよくあるエラー対策について詳しく解説します。

トラブルシューティングとよくあるエラー対策

DataverseをPowerShellやAPIで管理する際には、さまざまなエラーが発生することがあります。本章では、Dataverseの一般的なトラブルとその解決方法について解説します。

1. PowerShellでDataverse環境に接続できない

エラー例：

Connect-AdminPowerPlatform : The remote server returned an error: (401) Unauthorized.

原因と対策：

  • Azure ADの認証情報が正しく設定されているか確認する
  • 使用しているアカウントが管理者権限を持っているか確認する
  • Connect-AdminPowerPlatform コマンドを実行する前に、正しいテナントIDとクライアントIDを使用しているかチェック

解決策：正しい認証情報でログイン

Connect-AdminPowerPlatform -TenantID "your-tenant-id"

または、pac auth create コマンドで認証を再設定する。

2. Dataverse APIを使用した際の認証エラー

エラー例：

Invoke-RestMethod : The remote server returned an error: (403) Forbidden.

原因と対策：

  • クライアントIDとシークレットが正しいか確認する
  • APIのアクセス許可が適切に設定されているか確認する
  • DataverseのエンドポイントURLが正しいかチェックする

解決策：アクセストークンの取得を確認する

$tokenResponse = Invoke-RestMethod -Uri "https://login.microsoftonline.com/your-tenant-id/oauth2/token" -Method Post -Body @{
    grant_type    = "client_credentials"
    client_id     = "your-client-id"
    client_secret = "your-client-secret"
    resource      = "https://yourorg.api.crm.dynamics.com"
}
$accessToken = $tokenResponse.access_token

取得した $accessToken をAPIのリクエストヘッダーに適用して、再度試す。

3. Dataverseテーブル作成時のエラー

エラー例：

Invoke-RestMethod : The request is invalid. Schema name is already in use.

原因と対策：

  • 同じスキーマ名のテーブルがすでに存在している
  • SchemaName に一意の値を設定する
  • 既存のテーブルをリストアップし、競合していないか確認する

解決策：既存のテーブルを確認する

$response = Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/EntityDefinitions" -Headers $headers -Method Get
$response.value | Select-Object DisplayName, SchemaName

競合しない新しいスキーマ名を設定して、テーブルを作成する。

4. PowerShellでレコードの追加ができない

エラー例：

Invoke-RestMethod : The remote server returned an error: (400) Bad Request.

原因と対策：

  • JSONのフォーマットが正しくない
  • 必須のフィールドが抜けている
  • データ型の不一致がある

解決策：リクエストの内容を確認する

$recordBody = @{
    "new_CustomerName" = "山田 太郎"
    "new_Email" = "yamada@example.com"
} | ConvertTo-Json -Depth 10

Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/new_CustomerTables" -Method Post -Headers $headers -Body $recordBody

エラー発生時は $response の詳細情報を確認することで、どのフィールドが問題なのかを特定できる。

5. セキュリティロールの適用ができない

エラー例：

Invoke-RestMethod : Cannot assign security role. Role not found.

原因と対策：

  • 指定した roleId が存在しない
  • 指定した userId が有効なユーザーではない
  • APIエンドポイントが正しく設定されていない

解決策：ロール一覧を取得し、正しい roleId を確認する

$response = Invoke-RestMethod -Uri "$dataverseUrl/api/data/v9.1/roles" -Method Get -Headers $headers
$response.value | Select-Object roleid, name

取得した roleId を使用して、ロールを正しく割り当てる。

6. Dataverseのデータ取得時のパフォーマンス問題

問題:
大量のデータを取得する際に、APIのレスポンスが遅くなる。

原因と対策:

  • クエリの最適化が必要
  • 必要なフィールドのみを取得する
  • $top パラメータを使用して、一度に取得する件数を制限する

解決策：ページネーションを活用する

$url = "$dataverseUrl/api/data/v9.1/new_CustomerTables?$select=new_CustomerName,new_Email&$top=50"
$response = Invoke-RestMethod -Uri $url -Method Get -Headers $headers
$response.value

これにより、不要なデータの取得を抑えてパフォーマンスを向上させることができる。

7. 環境の削除ができない

エラー例：

Invoke-RestMethod : Environment cannot be deleted because it contains active resources.

原因と対策：

  • 削除しようとしている環境にデータベースやリソースが残っている
  • 先にリソースを削除する必要がある

解決策：リソースを削除してから環境を削除する

# データベースの削除
pac admin delete-database --environment "your-environment-id"

# 環境の削除
pac admin delete-environment --id "your-environment-id"

これにより、不要な環境を削除できる。

8. まとめ

DataverseをPowerShellで管理する際には、さまざまなエラーが発生する可能性があります。本章では、

  • 認証エラー（PowerShell/Dataverse API）
  • テーブル作成時のエラー
  • データ操作時のエラー
  • セキュリティロール適用エラー
  • データ取得時のパフォーマンス問題
  • 環境の削除エラー

について、原因と解決策を紹介しました。

次章では、Dataverse環境の構築と管理の総括を行います。

まとめ

本記事では、PowerShellを活用してMicrosoft Dataverse環境を構築・管理する方法について詳しく解説しました。

具体的には、

  • Dataverseの基本概念と利点
  • PowerShellを用いたDataverse環境の作成
  • テーブルの作成とデータ管理
  • 権限管理とセキュリティ設定
  • Dataverse APIを活用した自動化
  • トラブルシューティングとエラー対策

など、Dataverseの運用に必要な技術を紹介しました。

PowerShellを活用することで、手動操作の手間を削減し、スクリプトによる環境の自動化と一括管理が可能になります。また、Dataverse APIと連携することで、さらに高度なデータ管理や外部システムとの統合も実現できます。

Dataverseを適切に活用し、業務アプリケーションの基盤を効率的に構築・管理していきましょう。

PowerShell
PowerShell 環境構築 Microsoft Dataverse CDS

コメント

コメントする

目次
  1. Microsoft Dataverseとは？
    1. Dataverseの主な特徴
    2. Dataverseの活用シーン
    3. Dataverseのメリット
  2. PowerShellでDataverse環境を構築するメリット
    1. 1. GUI操作と比較したPowerShellの利点
    2. 2. スクリプトによる自動化の重要性
    3. 3. DevOpsとの統合
    4. 4. まとめ
  3. PowerShellでのDataverse管理に必要なツール
    1. 1. Power Platform CLI（pac CLI）
    2. 2. Microsoft PowerShellモジュール（Microsoft.PowerPlatform）
    3. 3. Azure Active Directory (Azure AD) 認証
    4. 4. Dataverse Web API
    5. 5. まとめ
  4. PowerShellを使ったDataverse環境の作成手順
    1. 1. PowerShell環境の準備
    2. 2. PowerShellでDataverse環境にログイン
    3. 3. Dataverse環境の作成
    4. 4. Dataverse環境の詳細設定
    5. 5. 環境の削除（オプション）
    6. 6. まとめ
  5. Dataverseテーブルの作成とデータ管理
    1. 1. Dataverseのテーブルとは？
    2. 2. PowerShellを使ったDataverseテーブルの作成
    3. 3. テーブルへの列（カラム）の追加
    4. 4. Dataverseのテーブルにデータを追加
    5. 5. Dataverseのテーブルデータを取得
    6. 6. Dataverseのテーブルデータを更新
    7. 7. Dataverseのテーブルデータを削除
    8. 8. まとめ
  6. Dataverseの権限管理とセキュリティ設定
    1. 1. Dataverseの権限管理の基本
    2. 2. PowerShellを使ったユーザーの追加
    3. 3. セキュリティロールの割り当て
    4. 4. チームを作成し、ユーザーを一括管理
    5. 5. ビジネスユニットを活用したアクセス制御
    6. 6. フィールドレベルセキュリティの設定
    7. 7. まとめ
  7. Dataverse APIを活用した拡張と自動化
    1. 1. Dataverse APIの概要
    2. 2. Dataverse APIの認証（OAuth 2.0）
    3. 3. Dataverse APIを使ったデータ操作
    4. 4. Dataverse APIとPower Automateの連携
    5. 5. Dataverse APIの応用例
    6. 6. まとめ
  8. トラブルシューティングとよくあるエラー対策
    1. 1. PowerShellでDataverse環境に接続できない
    2. 2. Dataverse APIを使用した際の認証エラー
    3. 3. Dataverseテーブル作成時のエラー
    4. 4. PowerShellでレコードの追加ができない
    5. 5. セキュリティロールの適用ができない
    6. 6. Dataverseのデータ取得時のパフォーマンス問題
    7. 7. 環境の削除ができない
    8. 8. まとめ
  9. まとめ