The available build tasks are described in the following sections. Afterwards, we showcase some example Azure Pipelines making use of these tasks. For information about the build tools and how to download them, see Microsoft Power Platform Build Tools for Azure Pipelines.
Helper task
The available helper tasks are described next.
Power Platform Tool Installer
This task is required to be added once before any other Power Platform Build Tools tasks in build and
release pipelines. This task installs a set of Power Platform–specific tools required
by the agent to run the Microsoft Power Platform build tasks. This task doesn't require any
more configuration when added. This task contains parameters for the specific versions
of each of the tools that are being installed.
To stay up to date with the tool versions over time, make sure these parameters correspond
to the versions of the tools that are required for the pipeline to run properly.
# Installs specific versions of the Power Platform Build Tools
- task: microsoft-IsvExpTools.PowerPlatform-BuildTools.tool-installer.PowerPlatformToolInstaller@2
displayName: 'Power Platform Tool Installer'
inputs:
DefaultVersion: false
XrmToolingPackageDeploymentVersion: 3.3.0.928
Parameters (Installer)
Parameters
Description
DefaultVersion Use default tool versions
Set to true to use the default version of all tools, otherwise false. Required (and false) when any tool versions are specified.
PowerAppsAdminVersion XrmToolingPackageDeploymentVersion MicrosoftPowerAppsCheckerVersion CrmSdkCoreToolsVersion Tool version
The specific version of the tool to use.
Power Platform WhoAmI
Verifies a Power Platform environment service connection by connecting and making a WhoAmI request. This task can be useful to include early in the pipeline, to verify connectivity before processing begins.
YAML snippet (WhoAmI)
# Verifies an environment service connection
- task: microsoft-IsvExpTools.PowerPlatform-BuildTools.whoami.PowerPlatformWhoAmi@2
displayName: 'Power Platform WhoAmI'
inputs:
# Service Principal/client secret (supports MFA)
authenticationType: PowerPlatformSPN
PowerPlatformSPN: 'My service connection'
# Verifies an environment service connection
- task: microsoft-IsvExpTools.PowerPlatform-BuildTools.whoami.PowerPlatformWhoAmi@2
displayName: 'Power Platform WhoAmI'
inputs:
# Username/password (no MFA support)
PowerPlatformEnvironment: 'My service connection'
Parameters (WhoAmI)
Parameters
Description
authenticationType Type of authentication
(Optional) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
PowerPlatformEnvironment Power Platform environment URL
The service endpoint for the environment to connect to. Defined under Service Connections in Project Settings. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
PowerPlatformSPN Power Platform Service Principal
The service endpoint for the environment to connect to. Defined under Service Connections in Project Settings.
Quality check
In the next section are the available tasks for checking the quality of a solution.
Power Platform Checker
This task runs a static analysis check on your solutions
against a set of best-practice rules to identify any problematic patterns that
you might inadvertently introduced when building your solution.
YAML snippet (Checker)
# Static analysis check of your solution
- task: microsoft-IsvExpTools.PowerPlatform-BuildTools.checker.PowerPlatformChecker@2
displayName: 'Power Platform Checker '
inputs:
PowerPlatformSPN: 'Dataverse service connection'
RuleSet: '0ad12346-e108-40b8-a956-9a8f95ea18c9'
(Required) A connection to a licensed Microsoft Power Platform environment is required to use the Power Platform checker. Service connections are defined in Service Connections under Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
Required when UseDefaultPACheckerEndpoint is false. You may specify another geo to use, for example https://japan.api.advisor.powerapps.com. For a list of available geographies, see Use the Power Platform Checker API.
FileLocation Location of files to analyze
Required when referencing a file from a shared access signature (SAS) URL sasUriFile.
Note: It's important to reference an exported solution file and not the unpacked source files in your repository. Both managed and unmanaged solution files can be analyzed.
FilesToAnalyzeSasUri SAS files to analyze
Required when FileLocation is set to sasUriFile. Enter the SAS URI. You can add more than one SAS URI through a comma (,) or semi-colon (;) separated list.
FilesToAnalyze Local files to analyze
Required when SAS files aren't analyzed. Specify the path and file name of the zip files to analyze. Wildcards can be used. For example, enter **\*.zip for all zip files in all subfolders.
FilesToExclude Local files to exclude
Specify the names of files to be excluded from the analysis. If more than one, provide through a comma (,) or semi-colon (;) separated list. This list can include a full file name or a name with leading or trailing wildcards, such as *jquery or form.js
RulesToOverride Rules to override
A JSON array containing rules and levels to override. Accepted values for OverrideLevel are: Critical, High, Medium, Low, Informational. Example: [{"Id":"meta-remove-dup-reg","OverrideLevel":"Medium"},{"Id":"il-avoid-specialized-update-ops","OverrideLevel":"Medium"}]
RuleSet Rule set
(Required) Specify which rule set to apply. The following two rule sets are available:
Solution checker: This rule set is the same one that is run from the Power Apps maker portal.
AppSource: The extended rule set that is used to certify an application before it can be published to AppSource.
ErrorLevel Error Level
Combined with the error, threshold parameter defines the severity of errors and warnings that are allowed. Supported threshold values are <level>IssueCount where level=Critical, High, Medium, Low, and Informational.
ErrorThreshold Error threshold
Defines the number of errors (>=0) of a specified level that are allowed for the checker to pass the solutions being checked.
FailOnPowerAppsCheckerAnalysisError Fail on error
When true, fail if the Power Apps Checker analysis is returned as Failed or FinishedWithErrors.
ArtifactDestinationName DevOps artifact name
Specify the Azure Artifacts name for the checker .sarif file.
Solution tasks
This set of tasks can automate solution actions. The environment tasks outlined later in this section that create, copy, or restore an environment overwrite the service connections with the newly created environments. These tasks make it possible to perform solution tasks against environments that are created on demand.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint that you want to import the solution into (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to import the solution into (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
SolutionInputFile Solution input file
(Required) The path and file name of the solution .zip file to import into the target environment (for example, $(Build.ArtifactStagingDirectory)$(SolutionName).zip).
Note: Variables give you a convenient way to get key bits of data into various parts of your pipeline. See Use predefined variables for a comprehensive list.
HoldingSolution Import as a holding solution
An advance parameter (true|false) used when a solution needs to be upgraded. This parameter hosts the solution in Dataverse but does not upgrade the solution until the Apply Solution Upgrade task is run.
Specify whether the enforcement of dependencies related to product updates should be skipped (true|false).
ConvertToManaged Convert to managed
Specify whether to import as a managed solution (true|false).
AsyncOperation Asynchronous import
If selected (true), the import operation will be performed asynchronously. This is recommended for larger solutions as this task will automatically timeout after 4 minutes otherwise. Selecting asynchronous will poll and wait until MaxAsyncWaitTime has been reached (true|false).
MaxAsyncWaitTime Maximum wait time
Maximum wait time in minutes for the asynchronous operation; default is 60 min (1 hr), same as Azure DevOps default for tasks.
PublishWorkflows Activate processes after import
Specify whether any processes (workflows) in the solution should be activated after import (true|false).
UseDeploymentSettingsFile Use deployment settings file
Connection references and environment variable values can be set using a deployment settings file (true|false).
DeploymentSettingsFile Deployment settings file
(Required when UseDeploymentSettingsFile=true) The path and file name of the deployment settings file.
Power Platform Add Solution Component
Adds a solution component to an unmanaged solution.
The schema name or ID of the component to add to the target solution.
ComponentType Power Platform environment URL
The value that represents the solution component that you are adding. See Use predefined component types for a comprehensive list of component values.
SolutionUniqueName Name of the solution
Unique name of the solution.
AddRequiredComponents Any components required from other solution dependent on the solution component
(Optional) Indicates whether other solution components that are required by the solution component that you are adding should also be added to the unmanaged solution.
Environment Environment URL or ID
(Optional) Environment URL or ID of the target environment.
Power Platform Apply Solution Upgrade
Upgrades a solution that has been imported as a holding solution.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint that you want to upgrade the solution into (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to upgrade the solution into (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
SolutionName Solution name
(Required) The name of the solution to apply the upgrade. Always use the solution Name not its Display Name.
AsyncOperation Asynchronous upgrade
If selected (true), the upgrade operation will be performed as an asynchronous batch job. Selecting asynchronous will poll and wait until MaxAsyncWaitTime has been reached.
MaxAsyncWaitTime Maximum wait time
Maximum wait time in minutes for the asynchronous operation; default is 60 min (1 hr), same as Azure DevOps default for tasks.
Note
Variables give you a convenient way to get key bits of data into various parts of your pipeline. See Use predefined variables for a comprehensive list.
You can pre-populate connection reference and environment variables information for the target environment while importing a solution using a deployment settings file.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint that you want to upgrade the solution into (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to upgrade the solution into (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
SolutionName Solution name
(Required) The name of the solution to export. Always use the solution Name not its Display Name.
SolutionOutputFile Solution output file
(Required) The path and file name of the solution.zip file to export the source environment to (for example, $(Build.ArtifactStagingDirectory)$(SolutionName).zip ).
Note: Variables give you a convenient way to get key bits of data into various parts of your pipeline. See Use predefined variables for a comprehensive list.
AsyncOperation Asynchronous export
If selected (true), the export operation will be performed as an asynchronous batch job. Selecting asynchronous will poll and wait until MaxAsyncWaitTime has been reached.
MaxAsyncWaitTime Maximum wait time
Maximum wait time in minutes for the asynchronous operation; default is 60 min (1 hr), same as Azure DevOps default for tasks.
Managed Export as managed
If selected (true), export the solution as a managed solution; otherwise export as an unmanaged solution.
ExportOutlookSynchronizationSettings Export Outlook sync settings
Export Outlook synchronization settings (true|false).
ExportRelationshipRoles Export relationship roles
Export relationship roles (true|false).
ExportSales Exports sales
Exports sales (true|false).
Power Platform Unpack Solution
Takes a compressed solution file and decomposes it into multiple XML files so that these files can be more easily read and managed by a source control system.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint that you want to delete the solution (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to delete the solution (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
SolutionName Solution name
(Required) The name of the solution to delete. Always use the solution Name not its Display Name.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint that you want to publish the customizations (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to publish the customizations (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
Power Platform Set Solution Version
Updates the version of a solution.
YAML snippet (Version)
steps:
- task: microsoft-IsvExpTools.PowerPlatform-BuildTools.set-solution-version.PowerPlatformSetSolutionVersion@2
displayName: 'Power Platform Set Solution Version '
inputs:
authenticationType: PowerPlatformSPN
PowerPlatformSPN: 'Dataverse service connection '
SolutionName: 'Contoso_sample'
SolutionVersionNumber: 1.0.0.0
Parameters (Version)
Parameters
Description
authenticationType Type of authentication
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint that you want to set the solution version (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to set the solution version (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
SolutionName Solution name
(Required) The name of the solution to set the version for. Always use the solution Name not its Display Name.
SolutionVersionNumber Solution version number
(Required) Version number you want to set.
While version number can be hardcoded in the pipeline, it is recommended to use an Azure DevOps pipeline variable like BuildId.
This provides options to define the exact shape of version number under the "Options" tab, for example: $(Year:yyyy)-$(Month:MM)-$(Day:dd)-$(rev:rr)-3
This definition can then be used in the Set Solution Version task by setting the Version Number property with: $(Build.BuildId) instead of hard coding 20200824.0.0.2.
Alternatively a powershell inline task script $(Get-Date -Format yyyy.MM.dd.HHmm) output set to empty variable named SolutionVersion as Write-Host ("##vso[task.setvariable variable=SolutionVersion;]$version"), Set Solution Version as $(SolutionVersion).
Power Platform Set Connection Variables
Sets BuildTools.* variables to provide custom script tasks access to use the service connection as a single source of truth.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to set connection variables for. Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
timeoutInMinutes Timeout
Specifies the maximum time, in minutes, that a task is allowed to execute before being canceled by server. A zero value indicates an infinite timeout.
retryCountOnTaskFailure Number of retries if task failed
Specifies the number of retries for this task that will happen in case of task failure. Not supported for agent-less tasks.
ApplicationId Application Id for login
(Required for username/password) Application Id to use for login (See additional note below).
RedirectUri Redirect URI of the specificed app
(Required for username/password) Redirect URI of the specified app. Needed when specifying an App Id. (See additional note below).
Note
When using the username/password authentication type, the Application Id and Redirect Uri will be required. This authenticate oauth document has an explanation of why you need to create an app registration to authenticate with Dataverse.
When you connect using username/password authentication, the connection behaves as an application which is connecting on behalf of a user to Dataverse.
Power Platform Deploy Package
Deploys a package to an environment. Deploying a package as opposed to a single solution file provides an option to deploy multiple solutions, data, and code into an environment.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint that you want to deploy the package into (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to deploy the package into (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type. More information: see BuildTools.EnvironmentUrl under Power Platform Create Environment
PackageFile Package file
(Required) The path and file name of the package file assembly (.dll).
MaxAsyncWaitTime Maximum wait time
Maximum wait time in minutes for the asynchronous operation; default is 60 min (1 hr), same as Azure DevOps default for tasks.
Environment management tasks
Automate common Environment Lifecycle Management (ELM) tasks.
Power Platform Create Environment
Creates a new environment. Creating a new environment also automatically creates BuildTools.EnvironmentUrl.
Important
When set, BuildTools.EnvironmentUrl will be used as the default service connection for subsequent tasks in the pipeline. Each task described in this article only uses the endpoint from the service connection when BuildTools.EnvironmentUrl is not set.
A new environment can only be provisioned if your license or capacity
allows for the creation of additional environments. For more information on how to view capacity see Capacity page details.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint that you want to create the environment (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to create the environment (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
DisplayName Display name
(Required) The display name of the environment created.
LocationName Deployment region
(Required) The region that the environment should be created in.
EnvironmentSku Environment type
(Required) The type of instance to deploy. Options are Sandbox, Production, Trial, and SubscriptionBasedTrial.
AppsTemplate Apps
For a non-trial environment type, the supported apps are D365_CustomerService, D365_FieldService, D365_ProjectServiceAutomation, and D365_Sales.
CurrencyName Currency
(Required) Base currency for the environment created. The currency cannot be updated after the environment is created.
LanguageName Language
(Required) The base language in the environment.
DomainName Domain Name
(Required) This is the environment-specific string that forms part of the URL. For example, for an environment with the following URL: https://powerappsbuildtasks.crm.dynamics.com/, the domain name would be 'powerappsbuildtasks'.
Note: If you enter a domain name that's already in use, the task appends a numeric value to the domain name, starting with 0. For the example above, the URL might become https://powerappsbuildtasks0.crm.dynamics.com/.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint that you want to delete the environment (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to delete the environment (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
Power Platform Assign User
Assign a user to a target environment with specified security role.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformSPN Power Platform Service Principal
The service endpoint for the environment that you want to assign the user to (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
User Power Platform user name
Microsoft Entra object ID or user's principal name to assign to the target environment.
Role Security role name or ID
Security role name or ID to be assigned to the user.
ApplicationUser Power Platform application user name
Specifies whether the input user is an application user (true|false).
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint that you want to reset the environment (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to reset the environment (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint that you want to back up the environment (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
PowerPlatformSPN Power Platform Service Principal
The service endpoint that you want to back up the environment (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
BackupLabel Backup label
(Required) The label to be assigned to the backup.
Power Platform Copy Environment
Copies an environment to a target environment. Two types of copies are available: full and minimal. A Full copy includes both data and solution metadata (customizations), whereas a minimal copy only includes solution
metadata and not the actual data.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint for the source environment that you want to copy from (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
PowerPlatformSPN Power Platform Service Principal
The service endpoint for the source environment that you want to copy from (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
TargetEnvironmentUrl Target environment URL
(Required) The URL for the target environment that you want to copy to.
CopyType Copy type
The type of copy to perform: FullCopy or MinimalCopy
OverrideFriendlyName Override friendly name
Change the target environment's friendly name to another name (true|false).
FriendlyName Friendly name
The friendly name of the target environment.
DisableAdminMode Disable admin mode
Whether to disable administration mode (true|false).
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformEnvironment Power Platform environment URL
The service endpoint for the source environment that you want to restore from (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
PowerPlatformSPN Power Platform Service Principal
The service endpoint for the source environment that you want to restore from (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
RestoreLatestBackup Latest backup to restore
Whether to restore latest backup or provide RestoreTimeStamp (true|false).
RestoreTimeStamp DateTime of the backup
DateTime of the backup in 'mm/dd/yyyy hh:mm' format OR string 'latest'.
TargetEnvironmentUrl Target environment URL
(Required) The URL for the target environment that you want to restore.
FriendlyName Name of the restored environment
(Optional) Name of the restored environment.
DisableAdminMode Disable admin mode
Whether to disable administration mode (true|false).
Export Dataverse Data
Export data from an environment with the provided schema.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformSPN Power Platform Service Principal
The service endpoint for the environment that you want to export data from (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
SchemaFile Schema XML file name
Schema XML file name. It can be created using the Configuration Migration tool.
DataFile Data file name
File name for data to export (zip file).
Overwrite Content overwrite
Power Pages website content to overwrite (true|false).
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformSPN Power Platform Service Principal
The service endpoint for the environment that you want to import data (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
DataFile Data file name
File name for compressed zip) data file to import, or the folder with data-schema.xml and data.xml to be imported.
Power Pages management tasks
Tasks for working with a Power Pages website.
Power Platform Download PAPortal
Download Power Pages website content from the current Dataverse environment.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformSPN Power Platform Service Principal
The service endpoint for the environment that you want to download content from (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
WebsiteId Portal website ID
Power Pages website ID to download.
Overwrite Content overwrite
Power Pages website content to overwrite (true|false).
ModelVersion Site Data Model
Indicates if the site data to be uploaded will use the standard (1) or enhanced data model (2). Default value is '1'.
Power Platform Upload PAPortal
Upload Power Pages website content to the current Dataverse environment.
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformSPN Power Platform Service Principal
The service endpoint for the environment that you want upload content to (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
UploadPath Upload content path
Path from where the Power Pages website content will be uploaded.
ModelVersion Site Data Model
Indicates if the site data to be uploaded will use the standard (1) or enhanced data model (2). Default value is '1'.
Catalog for Power Platform tasks (preview)
These tasks perform actions against the catalog in Power Platform and include the following.
Note
Currently, catalog tasks for Power Platform are a preview release.
Install catalog item
Install a catalog item to the target environment.
Parameters
Description
authenticationType Type of authentication
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformSPN Power Platform Service Principal
The service endpoint for the environment that you want upload content to (for example, https://powerappsbuildtools.crm.dynamics.com). Defined under Service Connections in Project Settings using the Power Platform connection type.
Environment Target environment URL
(Required) Environment url this task targets.
CatalogItemId Catalog Item ID to be installed
(Required) Catalog item to be installed on the target environment.
TargetEnvironmentUrl Target environment URL
(Required) The Url of the target environment for catalog item installation into (for example, "https://YourOrg.crm.dynamics.com").
PollStatus Check poll status
(Optional) Poll to check the status of your request (true|false).
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformSPN Power Platform Service Principal
The service endpoint for the environment that you want upload content to (for example, "https://powerappsbuildtools.crm.dynamics.com"). Defined under Service Connections in Project Settings using the Power Platform connection type.
Environment Target environment URL
(Required) Environment url this task targets.
CatalogSubmissionFile Catalog submission file
(Required) Specify the path and file name of the catalog submission file.
UsePackageSolutionZipFile File type
File type: package or solution zip file.
SolutionZipFile Solution zip file name
Specify the path and file name of the solution zip file.
PollStatus Check poll status
(Optional) Poll to check the status of your request (true|false).
Get the status of the catalog install/submit request.
Parameters
Description
authenticationType Type of authentication
(Required for SPN) Specify either PowerPlatformEnvironment for a username/password connection or PowerPlatformSPN for a Service Principal/client secret connection.
PowerPlatformSPN Power Platform Service Principal
The service endpoint for the environment that you want upload content to (for example, "https://powerappsbuildtools.crm.dynamics.com"). Defined under Service Connections in Project Settings using the Power Platform connection type.
Now that we've identified what can be done using the build tools, let's see
how you might apply these tools to your build and release pipelines. A
conceptual overview is shown below. Let's view some details of the pipeline implementation using the build tool tasks in the sub-sections that follow.
To learn more about creating these pipelines and actually do hands-on pipeline
authoring using the Microsoft Power Platform Build Tools, complete the build tools labs,
which you can download from GitHub.