pac.json
|
[
{ "name": "admin", "description": "Work with your Power Platform Admin Account.", "subcommands": [ { "name": "help", "description": "Work with your Power Platform Admin Account." }, { "name": "list", "description": "List all environments from your tenant", "params": [ { "name": "--organization-id", "description": "List all environments that contain given string in their organization id." }, { "name": "--type", "description": "List all environments with the given type." }, { "name": "--name", "description": "List all environments that contain given string in their name." }, { "name": "--environment", "description": "List all environments that contain given string in their name or id." }, { "name": "--json", "description": "Show results in raw JSON format." } ] }, { "name": "create", "description": "Creates a Dataverse database in your tenant.", "params": [ { "name": "--type", "description": "Sets the environment Type." }, { "name": "--currency", "description": "Sets the currency used for your environment. [defaults to USD]" }, { "name": "--domain", "description": "The domain name is part of the environment URL. If domain name is already in use, a numeric value will be appended to the domain name. Eg: If 'contoso' is already in use, then the environment URL will be updated to https://contoso0.crm.dynamics.com." }, { "name": "--name", "description": "Sets the name of the environment." }, { "name": "--max-async-wait-time", "description": "Max asynchronous wait time in minutes. Default value is 60 minutes" }, { "name": "--templates", "description": "Sets Dynamics365 app that needs to be deployed. [passed as comma separated values] e.g : -tm 'D365_Sample, D365_Sales'" }, { "name": "--team-id", "description": "Team Id as Guid" }, { "name": "--language", "description": "Sets the language used for your environment. [defaults to English]" }, { "name": "--async", "description": "Optional boolean argument to run pac verbs asynchronously, defaults to false." }, { "name": "--region", "description": "Sets the environment's region name. [defaults to unitedstates]" }, { "name": "--input-file", "description": "The verb arguments to be passed in a .json input file. Eg: 'name' : 'contoso'. The arguments passed through command-line will take precedence over arguments from the .json input file." } ] }, { "name": "backup", "description": "Takes a manual backup of your environment.", "params": [ { "name": "--label", "description": "Sets the backup label as provided." }, { "name": "--environment", "description": "Environment URL or ID of the Environment that requires backup." } ] }, { "name": "delete", "description": "Deletes Environment from your tenant", "params": [ { "name": "--max-async-wait-time", "description": "Max asynchronous wait time in minutes. Default value is 60 minutes." }, { "name": "--async", "description": "Optional boolean argument to run pac verbs asynchronously, defaults to false." }, { "name": "--environment", "description": "Environment URL or ID of the Environment that needs to be deleted from your tenant." } ] }, { "name": "reset", "description": "Reset environment from your tenant", "params": [ { "name": "--max-async-wait-time", "description": "Max asynchronous wait time in minutes. Default value is 60 minutes." }, { "name": "--currency", "description": "Sets the currency used for your environment. [defaults to USD]" }, { "name": "--domain", "description": "The domain name is part of the environment URL. If domain name is already in use, a numeric value will be appended to the domain name. Eg: If 'contoso' is already in use, then the environment URL will be updated to https://contoso0.crm.dynamics.com." }, { "name": "--name", "description": "Sets the name of the environment." }, { "name": "--templates", "description": "Sets Dynamics365 app that needs to be deployed. [passed as comma separated values] e.g : -tm 'D365_Sample, D365_Sales'" }, { "name": "--environment", "description": "URL or ID of the Environment that needs to be reset." }, { "name": "--language", "description": "Sets the language used for your environment. [defaults to English]" }, { "name": "--purpose", "description": "Sets the description used to associate the environment with a specific intent." }, { "name": "--async", "description": "Optional boolean argument to run pac verbs asynchronously, defaults to false." }, { "name": "--input-file", "description": "The verb arguments to be passed in a .json input file. Eg: 'name' : 'contoso'. The arguments passed through command-line will take precedence over arguments from the .json input file." } ] }, { "name": "list-backups", "description": "Lists all backups of your environment.", "params": [ { "name": "--environment", "description": "List all environments that contains given string in their Environment ID or URL." } ] }, { "name": "restore", "description": "Restores an environment to a given backup.", "params": [ { "name": "--source-env", "description": "Environment URL or ID pac of the source environment required for restore." }, { "name": "--target-env", "description": "Environment URL or ID of the target environment required for restore. This would default to source URL/ID if not provided." }, { "name": "--selected-backup", "description": "DateTime of the backup in 'mm/dd/yyyy hh:mm' format OR string 'latest'." }, { "name": "--name", "description": "Optional name of the restored environment." }, { "name": "--async", "description": "Optional boolean argument to run pac verbs asynchronously, defaults to false." }, { "name": "--max-async-wait-time", "description": "Max asynchronous wait time in minutes. Default value is 60 minutes." } ] }, { "name": "copy", "description": "Copy Source Environment to Destination Environment", "params": [ { "name": "--source-env", "description": "Environment URL or ID of the source environment that is being copied" }, { "name": "--target-env", "description": "Environment URL or ID of the target environment" }, { "name": "--name", "description": "Name of the target environment" }, { "name": "--type", "description": "Values: MinimalCopy, FullCopy" }, { "name": "--async", "description": "Optional boolean argument to run pac verbs asynchronously, defaults to false." }, { "name": "--max-async-wait-time", "description": "Max asynchronous wait time in minutes. Default value is 60 minutes." } ] }, { "name": "status", "description": "This command will list the status of all the operations in progress.", "params": [] }, { "name": "assign-user", "description": "Assign a user to a target environment.", "params": [ { "name": "--environment", "description": "ID or URL of the environment to assign a user to." }, { "name": "--user", "description": "Object ID or UPN of AAD user to be assigned to the environment or Application ID if assigning an Application User." }, { "name": "--role", "description": "Name or ID of security role to be applied to user" }, { "name": "--application-user", "description": "Specifies whether the input user is an application user. If business unit is not specified the application user will be added to the authenticated users business unit." }, { "name": "--business-unit", "description": "ID of business unit to associate application user with." }, { "name": "--async", "description": "Optional boolean argument to run pac verbs asynchronously, defaults to false." } ] }, { "name": "assign-group", "description": "Assign group to target Dataverse environment with specified security role.", "params": [ { "name": "--environment", "description": "ID or URL of the environment to assign a user to." }, { "name": "--group", "description": "AAD object id of group to assign to target Dataverse environment." }, { "name": "--group-name", "description": "Name of group/team that will created in Dataverse." }, { "name": "--role", "description": "Name or ID of security role to be applied to user." }, { "name": "--team-type", "description": "Type of team. Values: Owner, Access, AadSecurityGroup, AadOfficeGroup" }, { "name": "--membership-type", "description": "Team membership type. Values: MembersAndGuests, Members, Owners, Guests" }, { "name": "--business-unit", "description": "ID of business unit to associate application user with." } ] }, { "name": "list-app-templates", "description": "Lists all supported Dataverse database templates of model-driven apps in Dynamics 365.", "params": [ { "name": "--region", "description": "Sets the environment's region name. [defaults to unitedstates]" } ] } ] }, { "name": "application", "description": "Commands for listing and installing available Dataverse applications from AppSource.", "subcommands": [ { "name": "help", "description": "Commands for listing and installing available Dataverse applications from AppSource." }, { "name": "list", "description": "List available Dataverse applications from AppSource", "params": [ { "name": "--installState", "description": "Filter by application install state. Values: NotInstalled, Installed, All" }, { "name": "--output", "description": "Location of the JSON file to be created with list of the Dataverse applications from AppSource" }, { "name": "--environment", "description": "List available Dataverse applications for given environment (by id or url); if not specified, list all applications in the tenant" } ] }, { "name": "install", "description": "Installs Dataverse application to given environment", "params": [ { "name": "--application-name", "description": "Unique name of the application that will be installed to target environment" }, { "name": "--application-list", "description": "Location of the JSON file with list of the Dataverse applications from AppSource to be installed" }, { "name": "--environment", "description": "List available Dataverse applications for given environment (by id or url); if not specified, list all applications in the tenant" } ] } ] }, { "name": "auth", "description": "Manage how you authenticate to various services.", "subcommands": [ { "name": "help", "description": "Manage how you authenticate to various services." }, { "name": "name", "description": "Name or rename an existing authentication profile.", "params": [ { "name": "--index", "description": "The index of the profile to be named/renamed" }, { "name": "--name", "description": "The name you want to give to this authentication profile (maximum 30 characters)" } ] }, { "name": "create", "description": "Create and store authentication profiles on this computer.", "params": [ { "name": "--name", "description": "The name you want to give to this authentication profile (maximum 30 characters)" }, { "name": "--url", "description": "The resource URL to connect to" }, { "name": "--username", "description": "Optional: The username to authenticate with; shows AAD dialog if not specified" }, { "name": "--password", "description": "Optional: The password to authenticate with" }, { "name": "--applicationId", "description": "Optional: The application id to authenticate with" }, { "name": "--clientSecret", "description": "Optional: The client secret to authenticate with" }, { "name": "--certificateDiskPath", "description": " Optional: The certificate disk path to authenticate with" }, { "name": "--certificatePassword", "description": "Optional: The certificate password to authenticate with" }, { "name": "--tenant", "description": "Tenant id if using application id/client secret or application id/client certificate." }, { "name": "--cloud", "description": "Optional: The cloud instance to authenticate with Values: Public, UsGov, UsGovHigh, UsGovDod, Mooncake" }, { "name": "--managedIdentity", "description": "Use Azure Managed Identity." }, { "name": "--deviceCode", "description": "Use the AAD DeviceCode flow for interactive login." }, { "name": "--environment", "description": "Default environment (id, url, unique name or partial name)" } ] }, { "name": "select", "description": "Select which authentication profile should be active.", "params": [ { "name": "--index", "description": "The index of the profile to be active" }, { "name": "--name", "description": "The name of the profile to be active" } ] }, { "name": "list", "description": "List the authentication profiles stored on this computer.", "params": [] }, { "name": "clear", "description": "Clear all authentication profiles stored on this computer.", "params": [] }, { "name": "delete", "description": "Delete a particular authentication profile.", "params": [ { "name": "--index", "description": "The index of the profile to be deleted" }, { "name": "--name", "description": "The name of the profile to be active" } ] }, { "name": "update", "description": "Update name or target environment of an existing authentication profile.", "params": [ { "name": "--index", "description": "The index of the profile to be named/renamed" }, { "name": "--name", "description": "The name you want to give to this authentication profile (maximum 30 characters)" }, { "name": "--environment", "description": "Default environment (id, url, unique name or partial name)" } ] } ] }, { "name": "canvas", "description": "Operating with Power Apps .msapp files.", "subcommands": [ { "name": "help", "description": "Operating with Power Apps .msapp files." }, { "name": "unpack", "description": "(Preview) Extract an msapp file into sources", "params": [ { "name": "--msapp", "description": "Path to .msapp file" }, { "name": "--sources", "description": "Directory to sources to be unpacked" } ] }, { "name": "create", "description": "Generate a canvas app from a custom connector", "params": [ { "name": "--msapp", "description": "Path to .msapp file to be generated" }, { "name": "--connector-id", "description": "The ID of the Connector from which the Power App will be generated" }, { "name": "--connector-display-name", "description": "The display name of the Connector from which the Power App will be generated" }, { "name": "--environment", "description": "The target Environment ID. Default value is the environment of your currently active Dataverse Auth Profile." } ] }, { "name": "pack", "description": "(Preview) Pack sources into an msapp file", "params": [ { "name": "--msapp", "description": "Path to .msapp file" }, { "name": "--sources", "description": "Directory to sources to be packed" } ] } ] }, { "name": "connector", "description": "(Preview) Commands for working with Power Platform Connectors.", "subcommands": [ { "name": "help", "description": "(Preview) Commands for working with Power Platform Connectors." }, { "name": "list", "description": "(Preview) List the Connectors registered in Dataverse.", "params": [ { "name": "--environment", "description": "The target Environment ID or URL. Default value is the environment of your currently active Dataverse Auth Profile." }, { "name": "--json", "description": "Show results in raw JSON format." } ] }, { "name": "update", "description": "(Preview) Updates a Connector Entity in Dataverse.", "params": [ { "name": "--environment", "description": "The target Environment ID or URL. Default value is the environment of your currently active Dataverse Auth Profile." }, { "name": "--connector-id", "description": "The ID of the Connector." }, { "name": "--api-definition-file", "description": "The filename and path to read the the Connector's OpenApiDefinition." } ] }, { "name": "init", "description": "(Preview) Initializes a new API Properties file for a Connector", "params": [ { "name": "--connection-template", "description": "Generate an initial Connection Parameters set with specified template. Values: NoAuth, BasicAuth, ApiKey, OAuthGeneric, OAuthAAD." }, { "name": "--name", "description": "The Name of the Connector." }, { "name": "--display-name", "description": "The display name of the Connector." }, { "name": "--outputDirectory", "description": "Output directory." } ] }, { "name": "create", "description": "(Preview) Creates a new row in the Connector table in Dataverse.", "params": [ { "name": "--api-properties-file", "description": "The filename and path to read the the Connector's API Properties file." }, { "name": "--environment", "description": "The target Environment ID or URL. Default value is the environment of your currently active Dataverse Auth Profile." }, { "name": "--api-definition-file", "description": "The filename and path to read the the Connector's OpenApiDefinition." } ] }, { "name": "download", "description": "(Preview) Download a Connector's OpenApiDefinition and API Properties file", "params": [ { "name": "--outputDirectory", "description": "Output directory." }, { "name": "--connector-id", "description": "The ID of the Connector" }, { "name": "--environment", "description": "The target Environment ID or URL. Default value is the environment of your currently active Dataverse Auth Profile." } ] } ] }, { "name": "data", "description": "Import and export data from Dataverse.", "subcommands": [ { "name": "help", "description": "Import and export data from Dataverse." }, { "name": "export", "description": "Export data", "params": [ { "name": "--schemaFile", "description": "Schema file name. It can be created using Configuration Migration Tool." }, { "name": "--environment", "description": "Environment (id, org id, url, unique name or partial name)." }, { "name": "--verbose", "description": "Output more diagnostic information during data import/export." }, { "name": "--dataFile", "description": "File name for data zip file. Default data.zip." }, { "name": "--overwrite", "description": "Allow overwrite output data file if it already exists." } ] }, { "name": "import", "description": "Import data", "params": [ { "name": "--environment", "description": "Environment (id, org id, url, unique name or partial name)." }, { "name": "--verbose", "description": "Output more diagnostic information during data import/export." }, { "name": "--data", "description": "Zip file or directory name with data for import." } ] } ] }, { "name": "modelbuilder", "description": "Code Generator for Dataverse APIs and Tables.", "subcommands": [ { "name": "help", "description": "Code Generator for Dataverse APIs and Tables." }, { "name": "build", "description": "Builds a code model for Dataverse APIs and Tables", "params": [ { "name": "--generateActions", "description": "When set, Emits message classes as part of code generation." }, { "name": "--outdirectory", "description": "Write Directory for entity, message and optionset files." }, { "name": "--namespace", "description": "The namespace for the generated code. The default namespace is the global namespace." }, { "name": "--emitfieldsclasses", "description": "Generate a constants structure that contains all of the field names by entity at the time of code generation." }, { "name": "--language", "description": "The language to use for the generated proxy code. This can be either 'CS' or 'VB'. The default language is 'CS'." }, { "name": "--suppressINotifyPattern", "description": "When enabled, does not write the INotify wrappers for properties and classes." }, { "name": "--optionsetstypesfolder", "description": "Folder name that will contain messages. default is OptionSets." }, { "name": "--writesettingsTemplateFile", "description": "When Set, writes a settings file out to the output directory with the current passed settings or default settings." }, { "name": "--serviceContextName", "description": "The name for the generated service context. If a value is passed in, it will be used for the Service Context. If not, no Service Context will be generated. (alias: -sctx)" }, { "name": "--settingsTemplateFile", "description": "Contains Settings to be used for this run of the Dataverse Model Builder, overrides any duplicate parameters on command line. Cannot be set when --writesettingstemplate is used." }, { "name": "--messagestypesfolder", "description": "Folder name that will contain messages. default is Messages." }, { "name": "--entitytypesfolder", "description": "Folder name that will contain entities. default is Entities." }, { "name": "--suppressGeneratedCodeAttribute", "description": "When set, this suppress all generated objects being tagged with the code generation engine and version." }, { "name": "--generateGlobalOptionSets", "description": "Emit all Global OptionSets, note: if an entity contains a reference to a global optionset, it will be emitted even if this switch is not present." }, { "name": "--entitynamesfilter", "description": "Filters the list of entities are retrieved when reading data from Dataverse. Passed in as a semicolon separated list. Using the form <entitylogicalname>;<entitylogicalname>" }, { "name": "--messagenamesfilter", "description": "Filters the list of messages that are retrieved when reading data from Dataverse. Passed in as a semicolon separated list, required messages (Create, Update, Delete, Retrieve, RetrieveMultiple, Associate and Disassociate) are always included. An * can be used to proceed or trail an message allowing for all messages starting with or ending with a string. Using the form <messagename>;<messagename>." } ] } ] }, { "name": "org", "description": "Work with your Dataverse Organization.", "subcommands": [ { "name": "help", "description": "Work with your Dataverse Organization." }, { "name": "list", "description": "Lists all of the Dataverse Organizations the user has access to.", "params": [ { "name": "--filter", "description": "Show only environments containing filter criteria." } ] }, { "name": "who", "description": "Displays information about the current Dataverse Organization.", "params": [ { "name": "--json", "description": "Show results in raw JSON format." } ] }, { "name": "select", "description": "Select default organization for current authentication profile.", "params": [ { "name": "--environment", "description": "Default environment (id, url, unique name or partial name)." } ] } ] }, { "name": "package", "description": "Commands for working with Dataverse package projects.", "subcommands": [ { "name": "help", "description": "Commands for working with Dataverse package projects." }, { "name": "add-reference", "description": "Adds reference to Dataverse solution project", "params": [ { "name": "--path", "description": "The path to the referenced Dataverse solution project" }, { "name": "--import-order", "description": "A whole number that indicates the order to insert this item into the final ImportConfig.xml file at build time. Negative numbers are inserted before existing elements. Positive numbers are added after existing elements." }, { "name": "--publish-workflows-activate-plugins", "description": "Explicitly indicates whether to publish the workflows and activate plug-ins when this solution is imported. Values: true, false" }, { "name": "--overwrite-unmanaged-customizations", "description": "Explicitly indicates whether to overwrite unmanaged customizations when this solution is imported. Values: true, false" }, { "name": "--import-mode", "description": "Explicitly specifies the required mode when importing this solution. Values: sync, async" }, { "name": "--missing-dependency-behavior", "description": "Specifies the behavior on import when a dependency of this solution is missing from the target environment. Values: skip, fault" }, { "name": "--dependency-overrides", "description": "A semicolon delimited list of overrides. This value overrides any dependency information encoded in the solution's metadata. Each override should be in the format: `<uniquename>:<minVersion>:<maxVersion>`. Where the minVersion and maxVersion is optional but should be in .Net version format syntax." } ] }, { "name": "add-external-package", "description": "Adds a package that is external to the Dataverse solution system to a PD Package project", "params": [ { "name": "--path", "description": "Path to the external package." }, { "name": "--package-type", "description": "The type of the package being added. e.g. 'xpp' for FnO packages." }, { "name": "--import-order", "description": "A whole number that indicates the order to insert this item into the final ImportConfig.xml file at build time. Negative numbers are inserted before existing elements. Positive numbers are added after existing elements." }, { "name": "--skip-validation", "description": "Adds the item to the project file even if the file does not exist or appears to be invalid. Note, this will not affect any validation that is performed by MSBuild." } ] }, { "name": "init", "description": "Initializes a directory with a new Dataverse package project", "params": [ { "name": "--outputDirectory", "description": "Output directory." }, { "name": "--package-name", "description": "Sets the default name of the package. Applies to the generation of ImportExtension.GetNameOfImport." } ] }, { "name": "show", "description": "Shows details of Dataverse package", "params": [ { "name": "--package", "description": "Path to a package dll or zip file with a package." }, { "name": "--logFile", "description": "Log file path." }, { "name": "--verbose", "description": "Emit Verbose logs to the log outputs." } ] }, { "name": "deploy", "description": "Deploys package to Dataverse", "params": [ { "name": "--logFile", "description": "Log file path." }, { "name": "--logConsole", "description": "Output log to console." }, { "name": "--package", "description": "Path to a package dll or zip file with a package." }, { "name": "--settings", "description": "Runtime Package Settings that are passed to the package that is being deployed. The format of the string must be `key=value|key=value`." }, { "name": "--verbose", "description": "Emit Verbose logs to the log outputs." } ] }, { "name": "add-solution", "description": "Adds a prebuilt Dataverse solution file to a PD Package project", "params": [ { "name": "--path", "description": "Path to the Dataverse solution file (must be *.zip)" }, { "name": "--import-order", "description": "A whole number that indicates the order to insert this item into the final ImportConfig.xml file at build time. Negative numbers are inserted before existing elements. Positive numbers are added after existing elements." }, { "name": "--skip-validation", "description": "Adds the item to the project file even if the file does not exist or appears to be invalid. Note, this will not affect any validation that is performed by MSBuild." }, { "name": "--publish-workflows-activate-plugins", "description": "Explicitly indicates whether to publish the workflows and activate plug-ins when this solution is imported. Values: true, false" }, { "name": "--overwrite-unmanaged-customizations", "description": "Explicitly indicates whether to overwrite unmanaged customizations when this solution is imported. Values: true, false" }, { "name": "--import-mode", "description": "Explicitly specifies the required mode when importing this solution. Values: sync, async" }, { "name": "--missing-dependency-behavior", "description": "Specifies the behavior on import when a dependency of this solution is missing from the target environment. Values: skip, fault" }, { "name": "--dependency-overrides", "description": " A semicolon delimited list of overrides. This value overrides any dependency information encoded in the solution's metadata. Each override should be in the format: `<uniquename>:<minVersion>:<maxVersion>`. Where the minVersion and maxVersion is optional but should be in .Net version format syntax." } ] } ] }, { "name": "paportal", "description": "Commands for working with Power Pages website.", "subcommands": [ { "name": "help", "description": "Commands for working with Power Pages website." }, { "name": "list", "description": "List all Power Pages websites from the current Dataverse Organization", "params": [] }, { "name": "upload", "description": "Upload Power Pages website content to current Dataverse Organization", "params": [ { "name": "--path", "description": "Path from where the website content will be uploaded." }, { "name": "--deploymentProfile", "description": "Deployment profile name to be used. Defaults to 'default'." } ] }, { "name": "download", "description": "Download Power Pages website content from the current Dataverse Organization", "params": [ { "name": "--path", "description": "Path where the website content will be downloaded." }, { "name": "--includeEntities", "description": "Download only the entities specified for this argument in comma separated entity logical name." }, { "name": "--excludeEntities", "description": "Comma separated list of entity logical names to exclude downloading." }, { "name": "--webSiteId", "description": "Power Pages website id to download." }, { "name": "--overwrite", "description": "Power Pages website content to overwrite." } ] } ] }, { "name": "pcf", "description": "Commands for working with Power Apps component framework projects.", "subcommands": [ { "name": "help", "description": "Commands for working with Power Apps component framework projects." }, { "name": "init", "description": "Initializes a directory with a new Power Apps component framework project", "params": [ { "name": "--template", "description": "Choose a template for the component. Values: field, dataset." }, { "name": "--framework", "description": "The rendering framework for control. Default value is 'none'. Values: none, react." }, { "name": "--outputDirectory", "description": "Output directory." }, { "name": "--name", "description": "The name for the component." }, { "name": "--namespace", "description": "The namespace for the component." }, { "name": "--run-npm-install", "description": "Auto run 'npm install' after the control is created. Default value is 'false'." } ] }, { "name": "push", "description": "Import the Power Apps component framework project into the current Dataverse Organization", "params": [ { "name": "--force-import", "description": "Force a full update of the control." }, { "name": "--verbosity", "description": "Verbosity level for MSBuild when building the temporary solution wrapper. Values: minimal, normal, detailed, diagnostic." }, { "name": "--publisher-prefix", "description": "Customization prefix value for the Dataverse solution publisher." } ] }, { "name": "version", "description": "Patch version for controls", "params": [ { "name": "--updatetarget", "description": "Specify which target manifest needs to be updated. Values: build, project" }, { "name": "--patchversion", "description": "Patch version for controls." }, { "name": "--path", "description": "Absolute/Relative path of the 'ControlManifest.xml' for updating." }, { "name": "--strategy", "description": "Updates patch version for 'ControlManifest.xml' files using specified strategy. If using gittags, set personal access token in the following environment variable 'PacCli.PAT'. Values: gittags, filetracking, manifest." }, { "name": "--filename", "description": "Tracker CSV file name to be used when using filetracking as a strategy. Default value is ControlsStateVersionInfo.csv." }, { "name": "--allmanifests", "description": "Updates patch version for all 'ControlManifest.xml' files." } ] } ] }, { "name": "pipeline", "description": "Work with Pipelines.", "subcommands": [ { "name": "help", "description": "Work with Pipelines." }, { "name": "list", "description": "List Pipelines", "params": [ { "name": "--pipeline", "description": "Pipeline name or id for which show list of details such as deployment stages." } ] }, { "name": "deploy", "description": "Start pipeline deployment", "params": [ { "name": "--solutionName", "description": "Solution Name" }, { "name": "--stageId", "description": "Deployment Stage Id" }, { "name": "--environment", "description": "Deployment Environment" }, { "name": "--currentVersion", "description": "Current solution version" }, { "name": "--newVersion", "description": "New solution version" }, { "name": "--wait", "description": "Wait until deployment finishes" } ] } ] }, { "name": "plugin", "description": "Commands for working with Dataverse plug-in class library.", "subcommands": [ { "name": "help", "description": "Commands for working with Dataverse plug-in class library." }, { "name": "push", "description": "Import plug-in into Dataverse.", "params": [ { "name": "--configuration", "description": "Build configuration. Default: Debug." }, { "name": "--type", "description": "Type of item if not specified explicitly through --pluginFile. Default: Nuget Values: Nuget, Assembly." }, { "name": "--pluginFile", "description": "File name of plug-in assembly or plug-in package." }, { "name": "--pluginId", "description": "Id of plug-in assembly or plug-in package." } ] }, { "name": "init", "description": "Initializes a directory with a new Dataverse plug-in class library.", "params": [ { "name": "--outputDirectory", "description": "Output directory" }, { "name": "--signing-key-file-path", "description": "Relative path to the Dataverse plug-in assembly originator key file for signing." }, { "name": "--skip-signing", "description": "Skip plug-in assembly signing which gives plug-in assembly strong name. Default value is 'false'" }, { "name": "--author", "description": "Author(s) of the Dataverse Plug-in Package." } ] } ] }, { "name": "solution", "description": "Commands for working with Dataverse solution projects.", "subcommands": [ { "name": "help", "description": "Commands for working with Dataverse solution projects." }, { "name": "add-solution-component", "description": "Add solution component(s) to the target unmanaged solution in Dataverse.", "params": [ { "name": "--environment", "description": "Environment URL or ID of the target environment." }, { "name": "--component", "description": "The schema name or ID of the component to add to the target solution." }, { "name": "--componentType", "description": "The value that represents the solution component that you are adding." }, { "name": "--solutionUniqueName", "description": "Name of the solution." }, { "name": "--AddRequiredComponents", "description": "Indicates whether other solution components that are required by the solution component that you are adding should also be added to the unmanaged solution." } ] }, { "name": "online-version", "description": "Sets version for solution loaded in Dataverse.", "params": [ { "name": "--solution-version", "description": "Specify the solution version number." }, { "name": "--solution-name", "description": "Name of the solution." } ] }, { "name": "delete", "description": "Delete solution from Dataverse in the current Environment.", "params": [ { "name": "--solution-name", "description": "Name of the solution." } ] }, { "name": "clone", "description": "Create a solution project based on an existing solution in your Organization", "params": [ { "name": "--processCanvasApps", "description": "(Preview) Pack/unpack any Canvas apps (.msapp) while processing the solution. default: false." }, { "name": "--async", "description": "Exports solution asynchronously." }, { "name": "--include", "description": "Which settings should be included in the solution being exported. Values: autonumbering, calendar, customization, emailtracking, externalapplications, general, isvconfig, marketing, outlooksynchronization, relationshiproles, sales" }, { "name": "--outputDirectory", "description": "Output directory." }, { "name": "--name", "description": "The name of the solution to be exported." }, { "name": "--max-async-wait-time", "description": "Max asynchronous wait time in minutes. Default value is 60 minutes." }, { "name": "--packagetype", "description": "Specifies the extraction type for the solution. Can be: 'Unmanaged', 'Managed' or 'Both'; default: 'Both'." } ] }, { "name": "add-license", "description": "Add license and plan info to solution", "params": [ { "name": "--planMappingFile", "description": "License plan mapping file in CSV format; expected columns: Service ID, Component name." }, { "name": "--planDefinitionFile", "description": "License plan definition file in CSV format; expected columns: Service ID, Display name, More info URL." } ] }, { "name": "import", "description": "Import the solution into Dataverse.", "params": [ { "name": "--activate-plugins", "description": "Activate plug-ins and workflows on the solution." }, { "name": "--path", "description": "Path to solution zip file. If not specified, assumes the current folder is a cdsproj project." }, { "name": "--convert-to-managed", "description": "Convert as Managed Solution." }, { "name": "--import-as-holding", "description": "Import the solution as a holding solution." }, { "name": "--async", "description": "Imports solution asynchronously." }, { "name": "--force-overwrite", "description": "Force an overwrite of unmanaged customizations." }, { "name": "--publish-changes", "description": "Publish your changes upon a successful import." }, { "name": "--max-async-wait-time", "description": "Max asynchronous wait time in minutes. Default value is 60 minutes." }, { "name": "--settings-file", "description": "The .json file with the deployment settings for connection references and environment variables." }, { "name": "--skip-dependency-check", "description": "Skip dependency check against dependencies flagged as product update." } ] }, { "name": "pack", "description": "Package solution components on local filesystem into solution.zip (SolutionPackager)", "params": [ { "name": "--errorlevel", "description": "Minimum logging level for log output [Verbose|Info|Warning|Error|Off]; default: Info." }, { "name": "--localize", "description": "Extract or merge all string resources into .resx files." }, { "name": "--useLcid", "description": "Use LCID's (1033) rather than ISO codes (en-US) for language files." }, { "name": "--allowWrite", "description": "Dictates if write operations may occur; default: false." }, { "name": "--processCanvasApps", "description": "(Preview) Pack/unpack any Canvas apps (.msapp) while processing the solution. default: false." }, { "name": "--useUnmanagedFileForMissingManaged", "description": "Use the same XML source file when packaging for Managed and only Unmanaged XML file is found; applies to AppModuleSiteMap, AppModuleMap, FormXml files." }, { "name": "--sourceLoc", "description": "Generates a template resource file. Valid only on Extract. Possible Values are auto or an LCID/ISO code of the language you wish to export. When Present, this will extract the string resources from the given locale as a neutral .resx. If auto or just the long or short form of the switch is specified the base locale for the solution will be used." }, { "name": "--packagetype", "description": "When unpacking/extracting, use to specify dual Managed and Unmanaged operation. When packing, use to specify Managed or Unmanaged from a previous unpack 'Both'. Can be: 'Unmanaged', 'Managed' or 'Both'; default: 'Unmanaged'." }, { "name": "--disablePluginRemap", "description": "Disabled plug-in fully qualified type name remapping. default: false." }, { "name": "--allowDelete", "description": "Dictates if delete operations may occur; default: false." }, { "name": "--log", "description": "The path to the log file." }, { "name": "--map", "description": "The full path to a mapping xml file from which to read component folders to pack." }, { "name": "--clobber", "description": "Enables that files marked read-only can be deleted or overwritten; default: false." }, { "name": "--zipfile", "description": "The full path to the solution ZIP file." }, { "name": "--folder", "description": "The path to the root folder on the local filesystem. When unpacking/extractins, this will be written to, when packing this will be read from." }, { "name": "--singleComponent", "description": "Only perform action on a single component type [WebResource|Plugin|Workflow|None]; default: None." } ] }, { "name": "version", "description": "Update build or revision version for solution", "params": [ { "name": "--filename", "description": "Tracker CSV file name to be used when using filetracking as a strategy. Default value is ControlsStateVersionInfo.csv." }, { "name": "--revisionversion", "description": "Revision version for solution." }, { "name": "--strategy", "description": "Updates build version for 'solution.xml' file using specified strategy. If using gittags, set personal access token in the following environment variable 'PacCli.PAT'. Values: gittags, filetracking, solution." }, { "name": "--buildversion", "description": "Build version for solution." } ] }, { "name": "export", "description": "Export a solution from Dataverse.", "params": [ { "name": "--async", "description": "Exports solution asynchronously." }, { "name": "--managed", "description": "Whether the solution should be exported as a managed solution." }, { "name": "--include", "description": "Which settings should be included in the solution being exported. Values: autonumbering, calendar, customization, emailtracking, externalapplications, general, isvconfig, marketing, outlooksynchronization, relationshiproles, sales" }, { "name": "--path", "description": "Path where the exported solution zip file will be written." }, { "name": "--overwrite", "description": "The exported solution file can overwrite the solution zip file on the local file system." }, { "name": "--name", "description": "The name of the solution to be exported." }, { "name": "--max-async-wait-time", "description": "Max asynchronous wait time in minutes. Default value is 60 minutes." } ] }, { "name": "add-reference", "description": "Adds a reference from the project in the current directory to the project at 'path'", "params": [ { "name": "--path", "description": "The path to the referenced project." } ] }, { "name": "list", "description": "List all Solutions from the current Dataverse Organization", "params": [ { "name": "--environment", "description": "The target Environment ID or URL. Default value is the environment of your currently active Dataverse Auth Profile." }, { "name": "--json", "description": "Show results in raw JSON format." } ] }, { "name": "upgrade", "description": "Option to stage the Dataverse solution for upgrade", "params": [ { "name": "--max-async-wait-time", "description": "Max asynchronous wait time in minutes. Default value is 60 minutes." }, { "name": "--async", "description": "Upgrades solution asynchronously." }, { "name": "--solution-name", "description": "Name of the solution." } ] }, { "name": "create-settings", "description": "Create a settings file from solution zip or solution folder.", "params": [ { "name": "--settings-file", "description": "The .json file with the deployment settings for connection references and environment variables." }, { "name": "--solution-folder", "description": "Path to the local, unpacked solution folder: either the root of the 'Other/Solution.xml' file or a folder with a .cdsproj file." }, { "name": "--solution-zip", "description": "Path to solution zip file." } ] }, { "name": "check", "description": "Upload a Dataverse Solution project to run against the Power Apps Checker Service", "params": [ { "name": "--ruleSet", "description": "Select a rule set that will be executed as part of this build. Values: A valid Guid, 'AppSource Certification', 'solution Checker' (default)." }, { "name": "--geo", "description": "Which geographical instance of the Power Apps Checker service to use. Values: PreviewUnitedStates, UnitedStates, Europe, Asia, Australia, Japan, India, Canada, SouthAmerica, UnitedKingdom, France, Germany, UnitedArabEmirates, Switzerland, USGovernment, USGovernmentL4, USGovernmentL5DoD, China" }, { "name": "--customEndpoint", "description": "Specify a custom URL as Power Apps Checker endpoint." }, { "name": "--path", "description": "Path where the to-be-checked solution zip file(s) exist; path can contain glob/wildcard characters." }, { "name": "--solutionUrl", "description": "SAS Uri pointing to solution.zip to be analyzed." }, { "name": "--ruleLevelOverride", "description": "Path to a file containing a JSON array 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']." }, { "name": "--excludedFiles", "description": "Exclude Files from the Analysis. Pass as comma-separated values." }, { "name": "--outputDirectory", "description": "Output directory." } ] }, { "name": "init", "description": "Initializes a directory with a new Dataverse solution project", "params": [ { "name": "--publisher-prefix", "description": "Customization prefix value for the Dataverse solution publisher." }, { "name": "--outputDirectory", "description": "Output directory." }, { "name": "--publisher-name", "description": "Name of the Dataverse solution publisher." } ] }, { "name": "unpack", "description": "Extract solution components from solution.zip onto local filesystem (SolutionPackager)", "params": [ { "name": "--errorlevel", "description": "Minimum logging level for log output [Verbose|Info|Warning|Error|Off]; default: Info." }, { "name": "--localize", "description": "Extract or merge all string resources into .resx files." }, { "name": "--useLcid", "description": "Use LCID's (1033) rather than ISO codes (en-US) for language files." }, { "name": "--allowWrite", "description": "Dictates if write operations may occur; default: false." }, { "name": "--processCanvasApps", "description": "(Preview) Pack/unpack any Canvas apps (.msapp) while processing the solution. default: false." }, { "name": "--useUnmanagedFileForMissingManaged", "description": "Use the same XML source file when packaging for Managed and only Unmanaged XML file is found; applies to AppModuleSiteMap, AppModuleMap, FormXml files." }, { "name": "--sourceLoc", "description": "Generates a template resource file. Valid only on Extract. Possible Values are auto or an LCID/ISO code of the language you wish to export. When Present, this will extract the string resources from the given locale as a neutral .resx. If auto or just the long or short form of the switch is specified the base locale for the solution will be used." }, { "name": "--packagetype", "description": "When unpacking/extracting, use to specify dual Managed and Unmanaged operation. When packing, use to specify Managed or Unmanaged from a previous unpack 'Both'. Can be: 'Unmanaged', 'Managed' or 'Both'; default: 'Unmanaged'." }, { "name": "--disablePluginRemap", "description": "Disabled plug-in fully qualified type name remapping. default: false." }, { "name": "--allowDelete", "description": "Dictates if delete operations may occur; default: false." }, { "name": "--log", "description": "The path to the log file." }, { "name": "--map", "description": "The full path to a mapping xml file from which to read component folders to pack." }, { "name": "--clobber", "description": "Enables that files marked read-only can be deleted or overwritten; default: false." }, { "name": "--zipfile", "description": "The full path to the solution ZIP file." }, { "name": "--folder", "description": "The path to the root folder on the local filesystem. When unpacking/extractins, this will be written to, when packing this will be read from." }, { "name": "--singleComponent", "description": "Only perform action on a single component type [WebResource|Plugin|Workflow|None]; default: None." } ] }, { "name": "publish", "description": "Publishes all customizations", "params": [ { "name": "--max-async-wait-time", "description": "Max asynchronous wait time in minutes. Default value is 60 minutes." }, { "name": "--async", "description": "Publishes all customizations asynchronously." } ] }, { "name": "sync", "description": "Sync the current Dataverse solution project to the current state of the solution in your Organization.", "params": [ { "name": "--solution-folder", "description": "Path to the local, unpacked solution folder: either the root of the 'Other/Solution.xml' file or a folder with a .cdsproj file." }, { "name": "--async", "description": "Exports solution asynchronously." }, { "name": "--include", "description": "Which settings should be included in the solution being exported. Values: autonumbering, calendar, customization, emailtracking, externalapplications, general, isvconfig, marketing, outlooksynchronization, relationshiproles, sales" }, { "name": "--max-async-wait-time", "description": "Max asynchronous wait time in minutes. Default value is 60 minutes." }, { "name": "--processCanvasApps", "description": "(Preview) Pack/unpack any Canvas apps (.msapp) while processing the solution. default: false." }, { "name": "--packagetype", "description": "When unpacking/extracting, use to specify dual Managed and Unmanaged operation. When packing, use to specify Managed or Unmanaged from a previous unpack 'Both'. Can be: 'Unmanaged', 'Managed' or 'Both'; default: 'Unmanaged'." } ] } ] }, { "name": "telemetry", "description": "Manage telemetry settings.", "subcommands": [ { "name": "help", "description": "Manage telemetry settings." }, { "name": "status", "description": "Show the current status of telemetry", "params": [] }, { "name": "enable", "description": "Choose to send usage information to help Microsoft improve this product", "params": [] }, { "name": "disable", "description": "Choose to not send usage information to help Microsoft improve this product", "params": [] } ] }, { "name": "tool", "description": "Power Platform tools that can be installed and launched.", "subcommands": [ { "name": "help", "description": "Power Platform tools that can be installed and launched." }, { "name": "list", "description": "List the launchable tools and their local install state and version.", "params": [] }, { "name": "prt", "description": "Launch Plug-in Registration Tool (PRT)", "params": [ { "name": "--update", "description": "Update tool to latest available version from nuget.org." }, { "name": "--clear", "description": "Clear tool from local file cache." } ] }, { "name": "pd", "description": "Launch Package Deployer (PD)", "params": [ { "name": "--update", "description": "Update tool to latest available version from nuget.org." }, { "name": "--clear", "description": "Clear tool from local file cache." } ] }, { "name": "cmt", "description": "Launch Configuration Migration Tool (CMT)", "params": [ { "name": "--update", "description": "Update tool to latest available version from nuget.org." }, { "name": "--clear", "description": "Clear tool from local file cache." } ] } ] }, { "name": "virtual-agent", "description": "Commands for working with Power Virtual Agent bots", "subcommands": [ { "name": "help", "description": "Commands for working with Power Virtual Agent bots" }, { "name": "list", "description": " List of Virtual Agents in current or target Dataverse environment.", "params": [ { "name": "--environment", "description": "The target Environment ID or URL. Default value is the environment of your currently active Dataverse Auth Profile." } ] } ] }, { "name": "install", "description": "Install 'latest' or a specified version of the Microsoft PowerApps CLI", "subcommands": [ { "name": "latest", "description": "Install latest version of the Microsoft PowerApps CLI" } ] }, { "name": "use", "description": "Use 'latest' or a specified version of the Microsoft PowerApps CLI", "subcommands": [ { "name": "latest", "description": "Use latest version Microsoft PowerApps CLI" } ] } ] |