The Power Platform CLI is a great tool to use when you are working with the Power Platform. You can create Power Apps Component Framework (PCF) components with it, you can do tons of administrative actions, and much more! You can run these one by one in the console when you’re developing a Power Platform solution, but sometimes, you want to use multiple commands together. In this blog, I will show you how you can create scripts with Power Platform CLI.<\/p>\n
Imagine the following: I am an administrator who wants to create environments for developers. I will enable the use of PCF Controls in Canvas Apps, which is an environment setting. Of course, I also want to have good control over the developer environments, so I will also create a group in the environment for the administrators and assign system administrator rights to that group. On top of that, I also want to import solutions so that developers can have a flying start!<\/p>\n
That means I will have to use the following Power Platform CLI commands:<\/p>\n
You can follow along with this blog, and I encourage you to do so. To follow along in the right way, make sure to have the following tools installed:<\/p>\n
After installing these tools, make sure to connect to a tenant where you have an account with Power Platform Administrator rights. If you need a refresher on how to connect, read this blog<\/a>. Also – make sure to open a folder in Visual Studio Code where you can add the script file. Create a file in that folder called Let’s start by the creation of the environment. This can be done by running the You will see all the parameters of the command here. Some parameters in here don’t have to be set if you want to use the defaults. Examples of that are region (default: unitedstates), currency (default: USD) and language (default: English). In this case, I’ll keep it simple and use only a couple of parameters:<\/p>\n This command will create the environment and after it’s done, I will see the details of the environment. While this is nice, we of course want to be able to run other commands after this with those details. How do I do that?<\/p>\n Some commands have the option for the This is exactly what you want, because then you can turn it into a PowerShell object.<\/p>\n The following commands support the In PowerShell, you have the option to convert from JSON by using the ConvertFrom-Json command. If we combine that with the command above, and add the To make it easier for ourselves, lets also add this to a variable:<\/p>\n Add this line to the script file ( The next step is to switch to the newly created environment. Because you used the Add this to your script file, so that the script contains both the steps to create an environment and to switch to the new environment. Run the Now you have selected the new environment, the next steps will be easier, since you don’t need to add the Run the following command in the Visual Studio Code terminal to see all the settings in the environment:<\/p>\n This will show you a large list of settings. In this example you only need one of them, but I wanted to make sure you knew about this command and all the different options you have here. You can also use the The command will filter the settings to only one setting, the Note that the value is The next step is to create a Dataverse group for the administrators. I have created a security group in Microsoft Entra ID called Add this to the script file and make sure to replace the value for Now you have enabled the PCF controls in Canvas Apps, you are ready to import a solution. Changing the setting is a prerequisite of the solution you’re going to import. The Creator Kit<\/a> has a bunch of components available that I want to make available to the developer when they get the developer environment. To make that solution available, you first need to download it from the website<\/a>. When you have downloaded the solution, add it to the same folder as your script file.<\/p>\n To import a solution to an environment, you can use the Note that the value of the path can be different in your case since the version of the Creator Kit can change between the moment of writing this blog and when you try it out!<\/p>\n Now you should have a script available that does a bunch of things. Of course, you can build in a bunch more like error handling, try\/catch, turn it into a function with more parameters, and more. I hope this gives you an idea on how you can work with Power Platform CLI in scripting scenarios!<\/p>\n The full script is available below:<\/p>\n The Power Platform CLI is a great tool to use when you are working with the Power Platform. You can create Power Apps Component Framework (PCF) components with it, you can do tons of administrative actions, and much more! You can run these one by one in the console when you’re developing a Power Platform […]<\/p>\n","protected":false},"author":115431,"featured_media":1167,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[11],"class_list":["post-1148","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powerplatform","tag-cli"],"acf":[],"blog_post_summary":" The Power Platform CLI is a great tool to use when you are working with the Power Platform. You can create Power Apps Component Framework (PCF) components with it, you can do tons of administrative actions, and much more! You can run these one by one in the console when you’re developing a Power Platform […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powerplatform\/wp-json\/wp\/v2\/posts\/1148","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/powerplatform\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/powerplatform\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powerplatform\/wp-json\/wp\/v2\/users\/115431"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powerplatform\/wp-json\/wp\/v2\/comments?post=1148"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powerplatform\/wp-json\/wp\/v2\/posts\/1148\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powerplatform\/wp-json\/wp\/v2\/media\/1167"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/powerplatform\/wp-json\/wp\/v2\/media?parent=1148"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powerplatform\/wp-json\/wp\/v2\/categories?post=1148"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powerplatform\/wp-json\/wp\/v2\/tags?post=1148"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}CLI-script.ps1<\/code><\/p>\nCreate the environment<\/h2>\n
pac admin create<\/code> command. I always use the help command to learn more about the command. If your Visual Studio Code Terminal isn’t open yet, use Ctrl + ` to open it. Next, run the following in the Visual Studio Code terminal to learn more about the command:<\/p>\npac admin create help\n<\/code><\/pre>\npac admin create --name \"Developer Environment\" --type \"Developer\" --user \"user@lowcoderevolution.onmicrosoft.com\"\n<\/code><\/pre>\nUse the JSON parameter<\/h2>\n
--json<\/code> parameter. This is only available in the documentation and not via the help commands. When I visit the documentation<\/a> of the pac admin create<\/code> command, I can see there is a --json<\/code> parameter available. The description is: Returns the output of the command as a JSON formatted string.<\/p>\n--json<\/code> parameter:<\/p>\n\n
pac admin copy<\/code><\/li>\npac admin create<\/code><\/li>\npac admin list<\/code><\/li>\npac admin reset<\/code><\/li>\npac admin restore<\/code><\/li>\npac catalog list<\/code><\/li>\npac connector list<\/code><\/li>\npac env who<\/code><\/li>\npac solution list<\/code><\/li>\n<\/ul>\nConvert from JSON<\/h2>\n
--json<\/code> parameter to it, it would love something like this:<\/p>\npac admin create --name \"Developer Environment\" --type \"Developer\" --user \"user@lowcoderevolution.onmicrosoft.com\" --json | ConvertFrom-Json\n<\/code><\/pre>\n$devEnvironment = pac admin create --name \"Developer Environment\" --type \"Developer\" --user \"user@lowcoderevolution.onmicrosoft.com\" --json | ConvertFrom-Json\n<\/code><\/pre>\nCLI-script.ps1<\/code>) you created earlier. Run the command after adding it to your script file. After running the above command, the $devEnvironment<\/code> variable will contain the output of the pac admin create<\/code> command as a PowerShell object. Values like environment ID and environment URL will be available for you. Run $devEnvironment<\/code> after the pac admin create<\/code> command is done to see what’s in there.<\/p>\nSelect the newly created developer environment<\/h2>\n
$devEnvironment<\/code> variable, you can now use the environment ID. To switch environments, you need to use the pac env select<\/code> command:<\/p>\npac env select --environment $devEnvironment.EnvironmentId\n<\/code><\/pre>\npac env select<\/code> command you just added to the script. This will select the new environment you created.<\/p>\nUpdate the setting to use PCF inside of canvas apps<\/h2>\n
--environment<\/code> parameter to every command from now on.<\/p>\npac env list-settings\n<\/code><\/pre>\n--filter<\/code> parameter to filter the list. Let’s try that out by running the following command:<\/p>\npac env list-settings --filter iscustomcontrolsincanvasappsenabled\n<\/code><\/pre>\niscustomcontrolsincanvasappsenabled<\/code> setting. This setting shows if PCF in Canvas Apps is enabled or not. In your case, the value should be No<\/code> because this is the default. To change this, run the following command:<\/p>\npac env update-settings --name \"iscustomcontrolsincanvasappsenabled\" --value true\n<\/code><\/pre>\ntrue<\/code> and not Yes<\/code>. This has to do with the pac env list-settings<\/code> command, which lists the values in Yes\/No<\/code> instead of true\/false<\/code>. When updating the settings always use true<\/code> or false<\/code> in case of a Boolean. Add the above command for updating the setting to the script file. If you want to be extra sure, you could run the pac env list-settings<\/code> command again to see if the value changed from No<\/code> to Yes<\/code>.<\/p>\nAdd a security group to the environment for the administrators<\/h2>\n
Contoso Administrators<\/code>. Adding this group to the Dataverse environment is pretty easy. Run pac admin assign-group help<\/code> in the Visual Studio Code terminal to see which parameters are available. You don’t need all of them! In this case, you can limit it to the following command:<\/p>\npac admin assign-group --group-name \"Contoso Administrators\" --group \"4627d989-e3c3-45f9-9977-814cad8fe9a0\" --team-type \"AadSecurityGroup\" --membership-type \"Members\" --role \"System Administrator\"\n<\/code><\/pre>\n--group-name<\/code> and --group<\/code> to use your own values. Also, feel free to change the role if needed.<\/p>\nImport a solution<\/h2>\n
pac solution import<\/code> command. If you want to learn more about the parameters for that command, run pac solution import help<\/code>. In this case, you only need to use the --path<\/code> parameter, but in other scenarios, you might need other parameters as well. Add the following command to the script file:<\/p>\npac solution import --path .\\CreatorKitCore_1.0.20240529.1_managed.zip\n<\/code><\/pre>\nWrap up<\/h2>\n
$devEnvironment = pac admin create --name \"Developer Environment\" --type \"Developer\" --user \"user@lowcoderevolution.onmicrosoft.com\" --json | ConvertFrom-Json\npac env select --environment $devEnvironment.EnvironmentId\npac env update-settings --name \"iscustomcontrolsincanvasappsenabled\" --value true\npac admin assign-group --group-name \"Contoso Administrators\" --group \"4627d989-e3c3-45f9-9977-814cad8fe9a0\" --team-type \"AadSecurityGroup\" --membership-type \"Members\" --role \"System Administrator\"\npac solution import --path .\\CreatorKitCore_1.0.20240529.1_managed.zip\n<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"