Microsoft Power Platform CLI とは?

[アーティクル]
2024-10-16

Microsoft Power Platform CLI は、シンプルなワンストップの開発者/ISV 向け CLI です。開発者はこの CLI を使用して、次に関連する Microsoft Power Platform のさまざまな操作を実行できます:

環境のライフサイクル
認証
Microsoft Dataverse 環境
ソリューションパッケージ
Power Pages
コードコンポーネント
その他...

フィードバックを提供する

PAC CLI のフィードバックを表示および送信するには、github.com/microsoft/powerplatform-build-tools/discussions を使用します。

Microsoft Power Platform CLI のインストール

Power Platform CLI をスインストールする方法は 3 つあります。同じコンピューターで、複数のインストールメソッドを使用できます。

メソッド	OS のサポート	説明
Visual Studio コード拡張機能をインストールする	Windows、Linux、macOS	Windows 10、Windows 11、Linux、macOS 上の Visual Studio Code で PowerShell ターミナル内のコマンドを使用できるようにします。このメソッドのみを使用してインストールする場合、既定では、コマンドプロンプト (CMD) および Windows 用 PowerShell ターミナルで PAC CLI を有効にしない限り、PAC CLI はVisual Studio Code ターミナル内のみで利用可能です
.NETツールでインストール	Windows、Linux、macOS	Windows 10、Windows 11、Linux、および macOS の PowerShell、CMD、または Bash シェル内でコマンドの使用を有効化します。このインストールメソッドは、Windows のみで利用可能な pac data または特定の pac package コマンド (展開および表示) の使用を有効化しません。
Windows MSIでインストール	Windows のみ	Windows のみの Visual Studio Code にある PowerShell ターミナル内で、コマンドの使用を有効化します。このインストールメソッドを使用して、インストールされたバージョンを管理することができます。

注意

次のコマンドは、Windows でのみ使用可能です。

このコマンドを Windows で使用するには、これらのインストールメソッドのいずれか (または両方) を使用して、Power Platform CLI をインストールします。

これらのコマンドは、.NET ツールを使用してインストールするだけの場合は、Windows で使用できません。

Power Platform CLI が既にインストールされているかどうかを確認します

使用しているオペレーションシステムに応じて、Power Platform CLI がインストールされているかどうかを判断する方法。

ウィンドウズ
macOS 10.12以降

PowerShell ターミナルを開く:
- Visual Studio Code 拡張機能のみをインストールした場合は、Visual Studio Code Powershell ターミナルを開きます。
- .NET ツールを使用してインストールした場合は、Visual Studio Code Powershell ターミナル、または Powershell ターミナルを開きます。
プロンプトでGet-Command pac | Format-List を入力し、Enter をクリックします。

結果は次のようになります。

Name            : pac.exe
CommandType     : Application
Definition      : C:\Users\you\.dotnet\tools\pac.exe
Extension       : .exe
Path            : C:\Users\you\.dotnet\tools\pac.exe
FileVersionInfo : File:             C:\Users\you\.dotnet\tools\pac.exe
                  InternalName:     pac.dll
                  OriginalFilename: pac.dll
                  FileVersion:      1.29.11
                  FileDescription:  Microsoft Power Platform CLI
                  Product:          Microsoft Power Platform&copy;
                  ProductVersion:   1.29.11+g9e2b163
                  Debug:            False
                  Patched:          False
                  PreRelease:       False
                  PrivateBuild:     False
                  SpecialBuild:     False
                  Language:         Language Neutral

Power Platform CLI がインストールされていない場合、次のエラーが表示されます。

Get-Command: The term 'pac' is not recognized as a name of a cmdlet, function, script file, or executable program.
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.

Power Platform CLI が Linux か macOS でインストールされているかどうかを確認するには、ターミナル/コマンドプロンプトを開いて、プロンプトで which pac を入力して Enter をクリックします。

結果は次のようになります。

/home/you/.dotnet/tools/pac

Power Platform CLI のどのバージョンがインストールされているかを確認する

コマンドプロンプト (Microsoft Windows) か、ターミナルセッション (Linux) を開いて、pac を入力してから Enterをクリックします。

次のように表示され、バージョンが 2 行目に表示されます。

Microsoft PowerPlatform CLI
Version: 1.30.3+g0f0e0b9

認証プロファイルを管理する

ほとんどの PAC CLI コマンドは、リソースへのアクセスが認証されている必要があります。認証プロファイルを作成して使用する必要があります。

注意

Visual Studio Code 拡張機能を使用して、認証プロファイルを表示して管理できます。

テナントに接続する

pac auth 作成コマンドを使用して、テナントに接続する。 pac auth create を実行すると、マシン上に認証プロファイルが作成されます。使用できる認証プロファイルは複数持つことができます。複数の認証プロファイルを持つと、複数のテナントで作業する際に便利です。たとえば、会社が複数のテナントを使用している場合 (開発、運営、テスト用に) や、複数の顧客に対応しているコンサルタントなどの場合です。

pac auth create コマンドには、便利なパラメータがいくつかあります。

--environment パラメーターを使用すると、自動的に適切な環境に接続できます。 --environment パラメーターを削除すると既定の環境に接続されますが、--environment パラメーターを追加すると異なる環境に接続することができます。環境 ID、URL、一意の名前、または名前の一部を値として使用できます。
インタラクティブなエクスペリエンスを使用することができない環境では、--deviceCode パラメーターを追加することで、まだ接続できることを確認できます。たとえば GitHub Codespaces では、pac auth createを実行したときに、--deviceCode パラメーターが自動的に追加されます。

例

HR-Dev 環境に接続するには、以下の例を使用できます。

pac auth create --environment "HR-Dev"

他の認証プロファイルに切り替える

複数の認証プロファイルがある場合は、pac auth list コマンドと pac auth select コマンドを使用して、簡単に切り替えることができます。

pac auth list コマンドは、マシン上に認証プロファイルをすべて一覧表示します。 pac auth select コマンドは、異なるコマンドを選択します。

`pac auth list` 例

すべての認証プロファイルを一覧表示するには、次の例を使用します。

pac auth list

pac auth list コマンドを実行して、認証プロファイルをすべて返します。

Index Active Kind      Name Friendly Name                   Url                                 User                                     Cloud  Type
[1]   *      UNIVERSAL      Personal Productivity (Default) https://x.crm.dynamics.com/         user@contoso.onmicrosoft.com             Public User

インデックス値を使用して他の認証プロファイルを選択します。

pac auth select --index 2

PowerShell でタブ補完を有効にする

Power Platform CLI には、.NET CLI の complete コマンドに似た pac complete コマンドがあります。

以下の手順に使用して構成すると、コマンドの先頭だけを入力してから、Tab キーを使用して入力を完了できます。

PAC CLI の PowerShell にタブ補完を追加するには、変数 $PROFILE に保存されているプロファイルを作成または編集します。詳細については、プロファイルの作成方法とプロファイルと実行ポリシーを参照してください。

以下のコードをプロファイルに追加します:

$scriptblock = {
    param($wordToComplete, $commandAst, $cursorPosition)

    &pac complete -s "$($commandAst.ToString())" | ForEach-Object {
        [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
    }
}

Register-ArgumentCompleter -Native -CommandName pac -ScriptBlock $scriptblock

その他のシェル

これは bash、zsh、fish、nushell でも使用できます。 dotnet complete の代わりに pac complete を使用します

US ソブリンクラウドの可用性

Microsoft Power Platform CLI は、GCC および GCC High (US ソブリンクラウド) リージョンで使用できます。サポート対象の米国ソブリンクラウド環境について調べる際は、pac auth create コマンドの --cloudを参照してください。

次の手順

そのコマンドについて説明します。サポートされているコマンドの完全なリストの場合、pac help コマンドか pac <subcommand> help コマンド - たとえばpac solution helpを実行します。

または、ドキュメントでコマンドの一覧を表示します。

Microsoft Power Platform CLIコマンドグループ

参照

Microsoft Power Platform CLIリリースノート
 Microsoft Power Platform CLIコマンドグループ
 Power Apps コンポーネントフレームワーク