Power Pages の Microsoft Power Platform CLI サポート

[アーティクル]
06/26/2024

Microsoft Power Platform CLI (コマンドラインインターフェース) は、開発者とアプリ開発者がコードコンポーネントを作成できるようにする、シンプルでワンストップの開発者向けコマンドラインインターフェイスです。

Microsoft Power Platform CLI ツーリングは、エンタープライズ開発者と ISV が拡張機能やカスタマイズを、すばやく効率的に作成、構築、デバッグ、および公開できる、包括的なアプリケーションライフサイクル (ALM) ストーリーの最初のステップです。詳細については、「Microsoft Power Platform CLI とは」を参照してください

この機能により、Microsoft Power Platform CLI は Power Pages サイト構成の CI/CD (継続的統合/継続的配置) を有効にします。 Microsoft Power Platform CLI を使用して、Web サイト構成をソース管理にチェックインし、任意の環境に Web サイト構成を移動できるようになりました。

注意

この機能は、Power Platform CLI バージョン1.9.8 以降で一般提供されました。最新バージョンのインストールについては、Microsoft Power Platform CLI のインストールを参照してください。
Power Platform CLI バージョン 1.27 以降、pac paportal コマンドは pac powerpages に変更されています。 paportal 引き続き機能しますが、今後は powerpages を使用することをお勧めします。この記事は間もなく、paportal の代わりに powerpages を使用するように更新される予定です。

Web サイト開発に Microsoft Power Platform CLI を使用する理由は何ですか?

Microsoft Power Platform CLI を使用して、Web サイトのコンテンツを変更することで、Web サイトのカスタマイズにオフラインのような機能を使用できるようになりました。すべてのカスタマイズまたは変更を保存したら、Web サイトの構成を Microsoft Dataverse にアップロードし直すことができます。 Microsoft Power Platform CLI を使用して Web サイトコンテンツをダウンロードすると、コンテンツは YAML および HTML 形式で構造化されるため、カスタマイズが容易になり、開発に適したエクスペリエンスを実現できます。

Microsoft Power Platform CLI のサポートによってポータルがメリットを受ける機能のリストを次に示します。

使いやすさ

ローカルファイルシステムから/への Web サイト構成データのダウンロード/アップロードをサポートします
既存の Microsoft Power Platform CLI ツールに構築します。

アプリケーションライフサイクル管理 (ALM)

組織内の Web サイト構成への変更を追跡します
組織またはテナント間で構成ファイルを移動します

プロ開発およびエンタープライズサポート

「git」などのソース管理ツールとシームレスに統合できます
CI/CD パイプラインを簡単に設定できます

Microsoft Power Platform CLI のインストール

詳細な手順については、Microsoft Power Platform CLI をインストール。

サポートするテーブル

Microsoft Power Platform CLI のポータルサポートは、以下の表に限定されます。

adx_ad

adx_adplacement

adx_blog

adx_blogpost

adx_botconsumer

adx_communityforum

adx_communityforumaccesspermission

adx_contentsnippet

adx_entityform

adx_entityformmetadata

adx_entitylist

adx_entitypermission

adx_forumthreadtype

adx_pagetemplate

adx_poll

adx_polloption

adx_pollplacement

adx_portallanguage

adx_publishingstate

adx_redirect

adx_shortcut

adx_sitemarker

adx_sitesetting

adx_tag

adx_urlhistory

adx_webfile

adx_webform

adx_webformmetadata

adx_webformstep

adx_weblink

adx_weblinkset

adx_webpage

adx_webpageaccesscontrolrule

adx_webrole

adx_website

adx_websiteaccess

adx_websitebinding (ダウンロードのみ)

adx_websitelanguage

adx_webtemplate

注釈

重要

カスタムテーブルおよびポータルテンプレート固有のテーブル (ブログ、コミュニティ、アイデアポータルなど) は、Microsoft Power Platform CLI を使用したカスタマイズではサポートされていません。
画像ファイルの添付書類と広告 (adx_ad) レコードは、Power Platform CLI を使ってダウンロードされます。回避策として、画像の URL フィールドを使うか、コピー フィールドの HTML 参照を、画像ファイルを含む Web ファイルレコードに追加することがあります。

ポータルの Microsoft Power Platform CLI をインストールして確認

Microsoft Power Platform CLI インストールについて学習するには、インストール Microsoft Power Platform CLI に移動してください。

Microsoft Power Platform CLI をインストール後、コマンドプロンプトを開き、pac を実行して、出力に「paportal」 - Power Apps ポータルのコマンドが含まれていることを確認します。

Microsoft Power Platform CLI で paportal コマンドを確認します。

ポータルの Microsoft Power Platform CLI コマンド

ポータルのMicrosoft Power Platform CLI コマンドは "paportal" です。

次のセクションでは、"paportal" コマンドの異なるプロパティの詳細を提供します。

Parameters

プロパティ名	説明設定	例
list	現在の Dataverse 環境のすべてのポータル Web サイトを一覧表示します。 -v パラメーターを追加して、サイトが標準または拡張データモデルを使用しているかどうかを示すことができます	`pac paportal list`
download	現在の Dataverse 環境からポータル Web サイトのコンテンツをダウンロードします。次のパラメーターがあります: - path: Web サイトのコンテンツを保存するパス (エイリアス: -p) - webSiteId: ダウンロードするポータル Web サイト ID (エイリアス: -id) - overwrite: (オプション) 既存のコンテンツを上書きする場合は true、フォルダーにすでに Web サイトのコンテンツがある場合に失敗する場合は false (エイリアス: -o) - modelVersion: `1` または `2` で、ダウンロードするサイトデータが標準 (1) と強化されたデータモデル (２) のどちらを使用するかを示します。	`pac paportal download --path "C:\portals" --webSiteId f88b70cc-580b-4f1a-87c3-41debefeb902 --modelVersion 2`
upload	現在の Dataverse 環境にポータル Web サイトのコンテンツをアップロードします。次のパラメーターがあります: - path: Web サイトのコンテンツを保存するパス (エイリアス: -p) -deploymentProfile: deployment-profiles/[profile-name].depoyment.yaml ファイルにプロファイル変数で定義された環境の詳細を含むポータルデータをアップロードします - modelVersion: `1` または `2` で、アップロードするサイトデータが標準 (1) と強化されたデータモデル (２) のどちらを使用するかを示します。	`pac paportal upload --path "C:\portals\starter-portal" --deploymentProfile "profile-name" --modelVersion 2`

デプロイプロファイルを使用する

deploymentProfile スイッチを使用すると、環境の変数のセットを YAML 形式で定義できます。たとえば、プロファイルで定義されたさまざまなスキーマの詳細を持つ、異なるデプロイプロファイル (dev、test、prod など) を持つことができます。

テストプロファイルを作成している場合は、deployment-profiles の下で、"test.deployment.yml" (つまり、<profileTag>.deployment.yml) を使用してファイルを作成できます。タグ (<profileTag>) でコマンドを実行して、このプロファイルを使用できます:

pac paportal upload --path "C:\portals\starter-portal" --deploymentProfile test --modelVersion 2

このファイルでは、deploymentProfile パラメータを使用してポータル構成をアップロードする間、テーブル ID、属性リストおよびオーバーライドしたい値を使用してテーブル (エンティティ) 名を持つことができます。

さらに、OS 変数を使用して、オペレーティングシステムの環境変数にアクセスできます。

一意のスキーマ詳細を持つ "test.deployment.yml" プロファイル YAML ファイルの例を次に示します。

adx_sitesetting:
    - adx_sitesettingid: 4ad86900-b5d7-43ac-1234-482529724970
      adx_value: ${OS.FacebookAppId} 
      adx_name: Authentication/OpenAuth/Facebook/AppId
    - adx_sitesettingid: 5ad86900-b5d7-43ac-8359-482529724979
      adx_value: contoso_sample
      adx_name: Authentication/OpenAuth/Facebook/Secret
adx_contentsnippet:
    - adx_contentsnippetid: b0a1bc03-0df1-4688-86e8-c67b34476510
      adx_name: PowerBI/contoso/sales
      adx_value:  https://powerbi.com/group/contoso/sales

注意

ポータルに加えて CLI で使用されるすべてのコマンドについて学習するには、Microsoft Power Platform CLI の一般的なコマンドに移動してください。

マニフェストファイル

pac paportal download CLI コマンドを使用して Web サイトのコンテンツをダウンロードすると、サイトコンテンツのダウンロードとともに 2 つのマニフェストファイルも生成されます。

環境マニフェストファイル (org-url-manifest.yml)
追跡マニフェストファイル (manifest.yml) を削除します

環境マニフェストファイル (org-url-manifest.yml)

環境マニフェストファイルは、pac paportal download コマンドが実行されるたびに生成されます。

ダウンロードのたびに、PAC CLI ツールは既存の環境マニフェストファイルを読み込み、環境内で削除されたエントリーを更新し、環境マニフェストファイルが存在しない場合は作成します。

pac paportal upload コマンドを実行すると、ポータル Web サイトのコンテンツがアップロードされます。環境マニフェストファイルを読み込んで、前回のダウンロード以降の変更点を特定し、更新されたコンテンツのみをアップロードします。これは、アップロードコマンドごとにすべてのコンテンツをアップロードするのではなく、更新されたウェブサイトのコンテンツのみをアップロードすることで、アップロード処理を最適化する際に役立ちます。

環境マニフェストファイルは、同じ環境 (環境 URL がファイル名と一致する) に接続するときは読み取り専用になり、誤って変更されることを防ぎます。

注意

環境マニフェストファイルは、Web サイトをさまざまな環境にデプロイする際の変更を追跡するようには設計されていません。
環境マニフェストファイルは、開発者が開発者環境でローカルにデプロイするために使用するように設計されており、git 無視リストに追加する必要があります。

追跡マニフェストファイル (manifest.yml) を削除します

このファイルは、環境から削除されたレコードを追跡するために使用されます。

pac paportal download コマンドを使用して Web サイトのコンテンツをダウンロードすると、環境マニフェストファイル (org-url-manifest.yml) から削除されたレコードが manifest.yml ファイルに追加されます。したがって、 pac paportal upload コマンドを使用して Web サイトのコンテンツをアップロードすると、環境からファイルが削除されます (別の環境に対してでも)。このファイルは削除されず、接続している環境に関係なく使用されます。このファイルは、ターゲット環境で項目を削除することを検討するために、変更をソース管理にプッシュするときに考慮する必要があります。

注意

PAC CLI を使用して、ある環境のサイトコンテンツレコードを削除し、別の環境の同じコンテンツレコードも削除するには、Web サイトレコードコンテンツを削除する前と後に pac paportal download コマンドを実行する必要があります。 manifest.yml はこれらの変更を追跡し、pac paportal upload コマンドが実行されると、ターゲット環境で対応するレコードを削除します。

Visual Studio Code 拡張機能を使用する

また、VS Code 拡張機能 Power Platform VS Code 拡張機能を使用して、IntelliSense の組み込みの Liquid 言語、コード補完支援、ヒント、および VS Code 統合ターミナルを使用した Microsoft Power Platform CLI との対話を行うこともできます。詳細: Visual Studio Code 拡張機能を使用する (プレビュー)

その他の考慮事項

ファイルパスがパスの最大長の制限を超えると、エラーが報告されます。詳細: Windows での最大パス長の制限
重複する Web ページ名などの重複レコードの場合、Microsoft Power Platform CLI は 2 つの異なるフォルダーを作成します。1 つは Web ページの名前、もう 1 つは同じ名前の先頭にハッシュコードを付けたフォルダーです。たとえば、「マイページ」や「マイページ ハッシュコード」。

次の手順

チュートリアル: ポータルで Microsoft Power Platform CLI を使用する

次の方法で共有

Power Pages の Microsoft Power Platform CLI サポート

Web サイト開発に Microsoft Power Platform CLI を使用する理由は何ですか?

使いやすさ

アプリケーションライフサイクル管理 (ALM)

プロ開発およびエンタープライズサポート

Microsoft Power Platform CLI のインストール

サポートするテーブル

ポータルの Microsoft Power Platform CLI をインストールして確認

ポータルの Microsoft Power Platform CLI コマンド

Parameters

デプロイプロファイルを使用する

マニフェストファイル

環境マニフェストファイル (org-url-manifest.yml)

追跡マニフェストファイル (manifest.yml) を削除します

Visual Studio Code 拡張機能を使用する

その他の考慮事項

次の手順

参照

フィードバック

フィードバック

その他のリソース

次の方法で共有

Power Pages の Microsoft Power Platform CLI サポート

Web サイト開発に Microsoft Power Platform CLI を使用する理由は何ですか?

使いやすさ

アプリケーション ライフサイクル管理 (ALM)

プロ開発およびエンタープライズ サポート

Microsoft Power Platform CLI のインストール

サポートするテーブル

ポータルの Microsoft Power Platform CLI をインストールして確認

ポータルの Microsoft Power Platform CLI コマンド

Parameters

デプロイ プロファイルを使用する

マニフェスト ファイル

環境マニフェスト ファイル (org-url-manifest.yml)

追跡マニフェスト ファイル (manifest.yml) を削除します

Visual Studio Code 拡張機能を使用する

その他の考慮事項

次の手順

参照

フィードバック

フィードバック

その他のリソース

アプリケーションライフサイクル管理 (ALM)

プロ開発およびエンタープライズサポート

デプロイプロファイルを使用する

マニフェストファイル

環境マニフェストファイル (org-url-manifest.yml)

追跡マニフェストファイル (manifest.yml) を削除します