Tutorial: Use Microsoft Power Platform CLI with portals
In this tutorial example, you’ll see how to get started with Microsoft Power Platform CLI to update sample portals configuration.
Download and install Visual Studio Code
To connect to Power Apps portals, and to use Microsoft Power Platform CLI commands, use Visual Studio Code and the integrated terminal. The integrated terminal makes it easy to connect to the Dataverse environment and to download, change, and upload the portals configuration. You can also use Windows PowerShell instead.
Step 1. Authenticate
Before you connect, list, download, or upload any changes for a Power Apps portal, you must authenticate to the Dataverse environment first. For more information about authentication using Microsoft Power Platform CLI, go to Microsoft Power Platform CLI – Auth.
To authenticate, open Windows PowerShell and run the following command using your Dataverse environment URL:
pac auth create -u [Dataverse URL]
pac auth create -u https://contoso-org.crm.dynamics.com
Follow the prompts of authentication to sign in to the environment.
Step 2. List available portals
Use the list command to list the available Power Apps portals in the Dataverse environment you connected to in the previous step.
pac paportal list
Step 3. Download portals content
Download portal website content from the connected Dataverse environment.
pac paportal download --path [PATH] -id [WebSiteId-GUID]
pac paportal download --path c:\pac-portals\downloads -id d44574f9-acc3-4ccc-8d8d-85cf5b7ad141
For the id parameter, use the WebSiteId returned from the output of the previous step.
Step 4. Change portals content
Change the configuration using Visual Studio Code and save your changes.
Ensure you update only the supported tables for use with Power Platform CLI. For more information, see Supported tables.
For example, the default portal page shows text such as this:
This text is visible from the webpage html:
You can alter this text and save the changes:
You can change the location of the folder path in PowerShell/integrated terminal to the downloaded location, and enter “code .” to open the folder directly in Visual Studio Code.
Step 5. Upload the changes
- If you're uploading to multiple environments, see upload the changes using deployment profile to learn how to upload changes using deployment profile.
- Ensure that the target environment's maximum attachment size is set to the same or greater size as your source environment.
- The maximum size of files is determined by the Maximum file size setting in the system settings email tab in the environment system settings dialog box.
After making the required changes, upload them using the following command:
pac paportal upload --path [Folder-location]
pac paportal upload --path C:\pac-portals\downloads\custom-portal\
Ensure the path for the portals content you entered is correct. By default, a folder named by the portal (friendly name) is created with downloaded portals content. For example, if the portal’s friendly name is custom-portal, the path for the above command (--path) should be C:\pac-portals\downloads\custom-portal.
The upload only happens for content that's been changed. In this example, since the change is made to a webpage, content is uploaded only for the adx_webpage table.
Upload the changes using deployment profile
When working with multiple different environments, you may consider using deployment profiles to ensure the changes are uploaded to the correct environment using deployment profile.
Create a folder named deployment-profiles inside the folder containing the portal content. For example, if the downloaded portal content is inside "starter-portal", deployment profiles folder should be inside this folder.
Inside deployment profiles folder, create a deployment YAML file that contains the environment-specific changes. For example, development environment can be called "dev.deployment.yml".
Edit the deployment YAML file using Visual Studio Code with the following format:
<table-name>: - <record-id>: <GUID> <column-name>: <Name> <column-value>: <Value>
For example, the following sample YAML code updates the value for "Browser Title Suffix" from default "Custom Portal" to "Custom Portal (Dev)".
adx_contentsnippet: - adx_contentsnippetid: 76227a41-a33c-4d63-b0f6-cd4ecd116bf8 # Replace with your content snippet ID adx_name: Browser Title Suffix # Setting name adx_value: · Custom Portal (Dev) # Setting value
To upload the changes to a different environment using a deployment profile YAML file, authenticate to the target org first.
After authenticated and connected to the correct environment, use the following command to upload the content:
pac paportal upload --path "C:\portals\starter-portal" --deploymentProfile dev
In the above example, the deployment profile name used is "dev" after following the previous steps to create a dev deployment profile. Change the name from "dev" to any other (such as QA for "qa.deployment.yml", or Test for "test.deployment.yml") if you've used a different filename for your deployment YAML file.
Step 6. Confirm the changes
To confirm the changes made to the portal webpage:
Browse to the portal webpage to see the change.
If you've used deployment profile example explained previously, the YAML snippet will update the value as shown below.
The browser title suffix updated through the above change shows the change when you open the portal in a browser:
This concludes the tutorial. You can repeat the above steps and change the portals content for other supported tables.
Submit and view feedback for