pac admin

Work with your PowerPlatform Admin Account

Commands

Command Description
pac admin assign-user Assign a user to a target environment.
pac admin backup Takes a manual backup of your environment.
pac admin copy Copy Source Environment to Destination Environment
pac admin create Creates a Dataverse Environment in your tenant.
pac admin delete Deletes Environment from your tenant
pac admin list List all environments from your tenant
pac admin list-app-templates Lists all supported Dataverse database templates of model-driven apps in Dynamics 365.
pac admin list-backups Lists all backups of your environment.
pac admin reset Reset environment from your tenant
pac admin restore Restores an environment to a given backup.
pac admin status This command will list the status of all the operations in progress.

pac admin assign-user

Assign a user to a target environment.

Required Parameters

--environment -env

ID or URL of the environment to assign a user to.

--role -r

Name or ID of security role to be applied to user

--user -u

Object ID of AAD user to be assigned to environment

Optional Parameters

--async -a

Optional boolean argument to run pac verbs asynchronously, defaults to false.

This parameter requires no value. It is a switch.

pac admin backup

Takes a manual backup of your environment.

Required Parameters

--label -l

Deprecated: This parameter will be ignored.

Optional Parameters

--environment -env

Environment URL or ID of the Environment that requires backup.

--environment-id -id

Deprecated: Use --environment instead.

--notes -n

Deprecated: This parameter will be ignored.

--url -u

Deprecated: Use --environment instead.

pac admin copy

Copy Source Environment to Destination Environment

Optional Parameters

--async -a

Optional boolean argument to run pac verbs asynchronously, defaults to false.

This parameter requires no value. It is a switch.

--name -n

Name of the target environment

--source-env -se

Environment URL or ID of the source environment that is being copied

--source-id -si

Deprecated: Use --source-env instead.

--source-url -su

Deprecated: Use --source-env instead.

--target-env -te

Environment URL or ID of the target environment

--target-id -ti

Deprecated: Use --target-env instead.

--target-url -tu

Deprecated: Use --target-env instead.

--type -t

Use one of these values:

  • MinimalCopy
  • FullCopy

pac admin create

Creates a Dataverse Environment in your tenant.

Required Parameters

--type -t

Sets the environment Type.

Use one of these values:

  • Trial
  • Sandbox
  • Production
  • Teams
  • SubscriptionBasedTrial

Optional Parameters

--async -a

Optional boolean argument to run pac verbs asynchronously, defaults to false.

This parameter requires no value. It is a switch.

--currency -c

Sets the currency used for your environment. [defaults to USD]

--domain -d

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://{contoso}0.crm.dynamics.com.

Note: Only characters within the ranges [A - Z], [a - z], [0 - 9], or '-' are allowed. The first and last character cannot be the '-' character. Consecutive '-' characters are not allowed.

--input-file -if

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.

--language -l

Sets the language used for your environment. [defaults to English]

--name -n

Sets the name of the environment.

--region -r

Sets the environment's region name. [defaults to unitedstates]

--team-id -tid

Team Id as Guid

Note: The Team Id must be a valid Guid.

--templates -tm

Sets Dynamics365 app that needs to be deployed. [passed as comma separated values] e.g : -tm "D365_Sample, D365_Sales"

pac admin delete

Deletes Environment from your tenant

Optional Parameters

--async -a

Optional boolean argument to run pac verbs asynchronously, defaults to false.

This parameter requires no value. It is a switch.

--environment -env

Environment URL or ID of the Environment that needs to be deleted from your tenant.

--environment-id -id

Deprecated: Use --environment instead.

--url -u

Deprecated: Use --environment instead.

pac admin list

List all environments from your tenant

Optional Parameters

--environment -env

List all environments that contain given string in their name or id.

--environment-id -id

Deprecated: Use --environment instead.

--name -n

List all environments that contain given string in their name.

--organization-id -oi

List all environments that contain given string in their organization id.

--type -t

List all environments with the given type.

Use one of these values:

  • Trial
  • Sandbox
  • Production
  • Teams
  • SubscriptionBasedTrial

--url -u

Deprecated: Use --environment instead.

pac admin list-app-templates

Lists all supported Dataverse database templates of model-driven apps in Dynamics 365.

Optional Parameters

--region -r

Sets the environment's region name. [defaults to unitedstates]

pac admin list-backups

Lists all backups of your environment.

Optional Parameters

--environment -env

List all environments that contains given string in their Environment ID or URL.

--environment-id -id

Deprecated: Use --environment instead.

--url -u

Deprecated: Use --environment instead.

pac admin reset

Reset environment from your tenant

Optional Parameters

--async -a

Optional boolean argument to run pac verbs asynchronously, defaults to false.

This parameter requires no value. It is a switch.

--currency -c

Sets the currency used for your environment. [defaults to USD]

--domain -d

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://{contoso}0.crm.dynamics.com.

--environment -env

URL or ID of the Environment that needs to be reset.

--environment-id -id

Deprecated: Use --environment instead.

--input-file -if

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.

--language -l

Sets the language used for your environment. [defaults to English]

--name -n

Sets the name of the environment.

--purpose -p

Sets the description used to associate the environment with a specific intent.

--templates -tm

Sets Dynamics365 app that needs to be deployed. [passed as comma separated values] e.g : -tm "D365_Sample, D365_Sales"

--url -u

Deprecated: Use --environment instead.

pac admin restore

Restores an environment to a given backup.

Required Parameters

--selected-backup -sb

DateTime of the backup in 'mm/dd/yyyy hh:mm' format OR string 'latest'.

Optional Parameters

--async -a

Optional boolean argument to run pac verbs asynchronously, defaults to false.

This parameter requires no value. It is a switch.

--name -n

Optional name of the restored environment.

--source-env -se

Environment URL or ID of the source environment required for restore.

--source-id -si

Deprecated: Use --source-env instead.

--source-url -su

Deprecated: Use --source-env instead.

--target-env -te

Environment URL or ID of the target environment required for restore. This would default to source URL/ID if not provided.

--target-id -ti

Deprecated: Use --target-env instead.

--target-url -tu

Deprecated: Use --target-env instead.

pac admin status

This command will list the status of all the operations in progress.

See also

Microsoft Power Platform CLI Command Groups
Microsoft Power Platform CLI overview