Edit

CoE CLI ALM accelerator for Microsoft Power Platform (Deprecated)

  • Article

Note

The CoE CLI is deprecated and will be removed in a future release. Use the Power Platform Project Setup Wizard to set up and manage your ALM Accelerator for Power Platform projects.

You can use the CLI application lifecycle management (ALM) accelerator for Microsoft Power Platform to manage common ALM tasks to install, set up, and administer the ALM accelerator for Microsoft Power Platform. This article contains:

Prerequisites

To set up the ALM accelerator for Microsoft Power Platform, you'll need to first install the CoE CLI.

Quick start

For an administrator, the quick start guide should take about 30 minutes. By the guide's end, you will have configured Microsoft Entra ID, Azure DevOps, and the Microsoft Power Platform environments.

  1. Validate the organization's maturity model for ALM.

  2. Create your Microsoft Power Platform environments, Azure DevOps organization, and Azure DevOps project.

  3. Create an installation configuration. Review the installation help for installation parameters.

    coe alm generate install -o quickstart.json

    This command generates a JSON configuration file similar to the following. Replace contoso with your tenant name.

    {
"log": [
   "info"
],
"components": [
   "all"
],
"aad": "ALMAcceleratorServicePrincipal",
"group": "ALMAcceleratorForMakers",
"devOpsOrganization": "https://dev.azure.com/contoso",
"project": "alm-sandbox",
"repository": "alm-sandbox",
"pipelineRepository": "coe-alm-accelerator-templates",
"environments": "https://contoso-prod.crm.dynamics.com/",
"settings": {
   "installEnvironments": [
      "validation",
      "test",
      "prod"
   ],
   "validation": "https://contoso-validation.crm.dynamics.com/",
   "test": "https://contoso-test.crm.dynamics.com/",
   "prod": "https://contoso-prod.crm.dynamics.com/",
   "createSecret": "true",
   "region": [
      "NAM"
   ]
},
"importMethod": "api",
"endpoint": "prod",
"$schema": "./alm.schema.json
}

    More information: CoE ALM generate install command

  4. Install the ALM accelerator by using the generated configuration file.

    coe alm install -f quickstart.json

    More information: CoE ALM install

    Deploying to your enterprise? For more information, go to Enterprise deployment.

    If you're prompted to create an HTTP with Microsoft Entra ID connection, enter https://graph.microsoft.com for both the Base Resource URL and Microsoft Entra Resource URI.

  5. Update permissions for the project build service to enable build pipelines to interact with Git repositories.

  6. Update pipeline permissions to resources to allow access to required resources.

  7. When your makers create development environments, run CoE ALM maker add to add the makers to Azure DevOps and share the ALM Accelerator for Power Platform canvas app.

    coe alm maker add 
   -o https://dev.azure.com/contoso 
   -p alm-sandbox 
   -e https://contoso-userdev.crm.dynamics.com 
   -aad ALMAcceleratorServicePrincipal 
   -g ALMAcceleratorForMakers -u user@contoso.com

    More information: CoE ALM maker add

    You can also generate a user configuration file. Using this approach, you can explore each parameter and review the settings before adding the maker.

    coe alm generate maker add -o user.config
coe alm maker add -f user.config

    More information: CoE ALM generate maker add

Understand the concepts

Not sure what ALM is and how it can help? Use the ALM accelerator for Microsoft Power Platform provides further context and examples of usage.

Getting started

  • Scenarios discusses different installation scenarios for ALM, from demo installations to enterprise deployments.
  • Personas describes key personas and how they map to ALM CLI commands and the wider ALM process.
  • Key concepts describes the key concepts for the components that are being automated "under the hood" by the CLI commands.
  • Branching and merging provides examples of the branching and merging approach of using ALM.

Sample installation

The following recording shows a sample generating an installation configuration file and installing ALM by using the configuration file in a demo deployment.

Example

Installation overview

  1. Review Before you start to ensure that you've created the required Microsoft Power Platform environments and Azure DevOps organizations.

  2. As an administrator, complete the admin installation.

  3. Have makers create development environments.

  4. Use maker setup to create and set up environment and solution branches in the Azure DevOps repository.

Note

If this is your first build pipeline, you'll need to set pipeline variables for your environment. At a minimum, you'll need to set the ServiceConnection variable to the environment you've set up for validation, test, and production.

Read more