Skip to content

New UnifiedEnvironment

FH-Inway edited this page Sep 17, 2026 · 1 revision

external help file: d365bap.tools-help.xml Module Name: d365bap.tools online version: schema: 2.0.0

New-UnifiedEnvironment

SYNOPSIS

Deploy a new Unified Environment in Power Platform Admin Center (PPAC).

SYNTAX

New-UnifiedEnvironment [-Type] <String> [-Name] <String> [[-CustomDomainName] <String>] [-Location] <String>
 [[-Region] <String>] [-NoDemoDb] [[-Version] <Version>] [[-SecurityGroup] <String>]
 [[-EnvironmentGroup] <String>] [[-PostProvisionDelaySeconds] <Int32>] [[-ReadyStateTimeoutMinutes] <Int32>]
 [-WaitForCompletion] [-EarlyRelease] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Deploys a new Unified Environment in Power Platform Admin Center (PPAC).

Support D365 Finance and Operations, either Developer Edition (UDE) or Unified Sandbox Environment (USE).

EXAMPLES

EXAMPLE 1

New-UnifiedEnvironment -Type "UDE" -Name "MyUdeEnv" -Location "Europe"

This will create a new Unified Developer Environment (UDE) named "MyUdeEnv" in the "Europe" location. It will include a demo database by default. It will get a default/unique domain name assigned by Power Platform. It will take the latest available version of Finance and Operations. It will not restrict access to the environment.

It will deploy into the North Europe region, as it's the default region for the Europe location.

EXAMPLE 2

New-UnifiedEnvironment -Type "USE" -Name "MyUseEnv" -Location "Europe" -Region "West Europe"

This will create a new Unified Sandbox Environment (USE) named "MyUseEnv" in the "Europe" location. It will deploy into the "West Europe" region. It will include a demo database. It will get a default/unique domain name assigned by Power Platform. It will take the latest available version of Finance and Operations. It will not restrict access to the environment.

EXAMPLE 3

New-UnifiedEnvironment -Type "UDE" -Name "MyUdeEnv" -Location "Europe" -CustomDomainName "myudeenv"

This will create a new Unified Developer Environment (UDE) named "MyUdeEnv" in the "Europe" location. It will include a demo database by default. It will get the custom domain name "myudeenv". It will take the latest available version of Finance and Operations. It will not restrict access to the environment.

EXAMPLE 4

New-UnifiedEnvironment -Type "USE" -Name "MyUseEnv" -Location "Europe" -NoDemoDb

This will create a new Unified Sandbox Environment (USE) named "MyUseEnv" in the "Europe" location. It will not include a demo database. It will get a default/unique domain name assigned by Power Platform. It will take the latest available version of Finance and Operations. It will not restrict access to the environment.

EXAMPLE 5

New-UnifiedEnvironment -Type "UDE" -Name "MyUdeEnv" -Location "Europe" -Version "10.0.44"

This will create a new Unified Developer Environment (UDE) named "MyUdeEnv" in the "Europe" location. It will include a demo database by default. It will get a default/unique domain name assigned by Power Platform. It will install version 10.0.44 of Finance and Operations. It will not restrict access to the environment.

EXAMPLE 6

New-UnifiedEnvironment -Type "USE" -Name "MyUseEnv" -Location "Europe" -SecurityGroup "MySecurityGroup"

This will create a new Unified Sandbox Environment (USE) named "MyUseEnv" in the "Europe" location. It will include a demo database by default. It will get a default/unique domain name assigned by Power Platform. It will take the latest available version of Finance and Operations. It will restrict access to the environment to members of the specified Entra Groups security group "MySecurityGroup".

EXAMPLE 7

New-UnifiedEnvironment -Type "UDE" -Name "MyUdeEnv" -Location "Europe" -EnvironmentGroup "D365FO"

This will create a new Unified Developer Environment (UDE) named "MyUdeEnv" in the "Europe" location. It will include a demo database by default. It will get a default/unique domain name assigned by Power Platform. It will take the latest available version of Finance and Operations. It will deploy into the "D365FO" environment group. The environment group could also be specified by its ID (a guid like "12345678-1234-1234-1234-123456789abc").

EXAMPLE 8

New-UnifiedEnvironment -Type "UDE" -Name "MyUdeEnv" -Location "Europe" -EarlyRelease

This will create a new Unified Developer Environment (UDE) named "MyUdeEnv" in the "Europe" location. The environment will be in the early release cycle. It will include a demo database by default. It will get a default/unique domain name assigned by Power Platform. It will take the latest available version of Finance and Operations. It will not restrict access to the environment.

PARAMETERS

-Type

Instructs the cmdlet to create either a Unified Sandbox Environment (USE) or a Unified Developer Environment (UDE).

Valid values are:

  • "USE": Deploys a Unified Sandbox Environment (USE) which is a sandbox environment without developer tools.
  • "UDE": Deploys a Unified Developer Environment (UDE) which is a sandbox environment with developer tools.
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Name of the new environment as it will be displayed in Power Platform Admin Center (PPAC).

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CustomDomainName

The custom domain name to be associated with the new environment.

E.g. "demo-time" will create the environment URLs:

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Location

The deployment location for the new environment.

This translates to the Power Platform location where the environment will be created.

Data residency and compliance requirements should be considered when selecting the location.

Get-PpacDeployLocation can be used to find available locations.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Region

The Azure region for the new environment.

It specifies the physical location of the data center where the environment will be hosted.

Get-PpacDeployLocation | Format-List can be used to find possible regions.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoDemoDb

Instructs the cmdlet to create the environment without a demo database.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Version

The version of the Finance and Operations application to be installed in the new environment.

Type: Version
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SecurityGroup

Entra Groups security group to restrict access to the new environment.

Type: String
Parameter Sets: (All)
Aliases: EntraGroup

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnvironmentGroup

The ID or display name of the environment group in which to create the shell environment.

Note that this will make the environment a managed environment.

Type: String
Parameter Sets: (All)
Aliases: EnvironmentGroupId, EnvironmentGroupName

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PostProvisionDelaySeconds

Additional delay (in seconds) after the shell environment reports as ready.

This pause helps ensure the platform application package endpoint is fully ready before install is attempted.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: 60
Accept pipeline input: False
Accept wildcard characters: False

-ReadyStateTimeoutMinutes

Maximum number of minutes to wait for the environment to reach state 'Ready'.

Prevents endless waiting when an environment is stuck in a non-ready state.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: 60
Accept pipeline input: False
Accept wildcard characters: False

-WaitForCompletion

Instructs the cmdlet to wait until the final provisioning app installation is completed.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-EarlyRelease

Instructs the cmdlet to create the environment in the early release cycle.

Note that not all locations/regions support early release environments.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Author: Mötz Jensen (@Splaxi) Author: Florian Hopfner (@FH-Inway)

RELATED LINKS

Clone this wiki locally