Admin

Commands to work with environment lifecycle features.

Parameters

Property Name Description
backup Takes the backup of an environment. It has the following parameters:
  • url: URL of the environment to be backed up (alias: -u).
  • label: Sets the backup label as provided (alias: -l).
  • environment-id: ID of the environment to be backed up (alias: -id).
  • notes: Additional notes provided for the backup (alias: -n).
create Creates a new environment. It has the following parameters:
  • name: Sets the name of the environment (alias: -n).
  • region: Sets the environment's region name. Defaults to unitedstates if not specified (alias -r).
  • type: Sets the type of the environment. Available values are Trial, Sandbox, Production, SubscriptionBasedTrial (alias: -t).
  • currency: Sets the default currency used in the environment. Defaults to USD if not specific (alias: -c).
  • language: Sets the default language of the environment. Defaults to English if not specified (alias: -l).
  • templates: Sets the Dynamics 365 apps that should be deployed to the environment. Pass as comma-separated values (alias: -tm).
  • domain: Sets the domain name that's part of the environment URL. If the domain name is already in use, a numeric value will be appended to the domain name. For example, if contoso is already in use, the environment URL will become https://contoso0.crm.dynamics.com (alias -d).
  • input-file: Arguments can be passed in a .json input file instead of through the command line. For example, {"name" : "contoso"}. The arguments passed through the command line will take precedence over arguments from the .json input file (alias: -if).
copy Copies a source environment to a destination environment. It has the following parameters:
  • source-url: URL of the source environment to be copied from (alias: -su).
  • target-url: URL of the target environment to be copied to (alias: -tu).
  • source-environment-id: ID of the source environment to be copied from (alias: -si).
  • target-environment-id: ID of the target environment to be copied to (alias: -ti).
  • name: Name to be used for the target environment (alias: -n).
  • type: Type of copy. Available values are: None, MinimalCopy, Fullcopy (alias: -t).
delete Deletes an environment. It has the following parameters:
  • url: URL of the environment to be deleted (alias: -u).
  • environment-id: ID of the environment to be deleted (alias: -id).
environment Allows to specify the URL or environment ID as its value.
list Lists all environments from the tenant. It has the following parameters
  • environment-id: List all environments that contain a given string in their ID (alias: -id).
  • url: List all environments that contain a given string in their URL (alias -u).
  • type: Lists all environments of the given type (alias: -t).
  • name: List all environments that contain a given string in their name (alias: -n).
  • organization-id: List all environments that contain a given string in their organization ID (alias: -oi).
list-backups Lists all available backups for the environment. It has the following parameters:
  • url: URL of the environment for which you want to list backups (alias: -u).
  • environment-id: ID of the environment for which you want to list backups (alias: -id).
reset Resets an environment. It has the following parameters:
  • url: URL of the environment to reset (alias: -u)
  • name: Sets the name of the environment (alias: -n).
  • currency: Sets the default currency used in the environment. Defaults to USD if not specified (alias: -c)
  • purpose: Sets the description used to associate the environment with a specific intent (alias: -p)
  • language: Sets the default language of the environment. Defaults to English if not specified (alias: -l).
  • templates: Sets the Dynamics 365 apps that should be deployed to the environment. Pass as comma-separated values (alias: -t).
  • domain: Sets the domain name that's part of the environment URL. If the domain name is already in use, a numeric value will be appended to the domain name. For example, if contoso is already use, the environment URL will become https://contoso0.crm.dynamics.com (alias -d).
  • input-file: Arguments can be passed in a .json input file instead of through the command line. For example, {"name" : "contoso"}. The arguments passed through the command line will take precedence over arguments from the .json input file (alias: -if).
restore Restores an environment from a given backup. It has the following parameters:
  • source-url: URL of the source environment to be restored from (alias: -s).
  • target-url: URL of the target environment to be restored to (alias: -t).
  • selected-backup: DateTime of the backup in mm/dd/yyyy hh:mm format or latest (alias: -sb).
  • name: Optional name of the restored environment (alias: -n).

See also

What is Microsoft Power Platform CLI?