Restore-PowerAppEnvironment

Module:

Microsoft.PowerApps.Administration.PowerShell Module

Restores an environment.

Syntax

Default (Default)

Restore-PowerAppEnvironment
    [-EnvironmentName] <String>
    [-RestoreToRequestDefinition] <Object>
    [[-WaitUntilFinished] <Boolean>]
    [[-TimeoutInMinutes] <Int32>]
    [[-ApiVersion] <String>]
    [<CommonParameters>]

Description

The Restore-PowerAppEnvironment cmdlet restores the specified Power Platform environment. Use Get-Help Restore-PowerAppEnvironment -Examples for more detail.

Examples

EXAMPLE 1

Restore-PowerAppEnvironment -EnvironmentName 0fc02431-15fb-4563-a5ab-8211beb2a86f -RestoreToRequestDefinition $restoreRequest

Restore environment 0fc02431-15fb-4563-a5ab-8211beb2a86f. $restoreRequest = [pscustomobject]@{ SourceEnvironmentId = 0fc02431-15fb-4563-a5ab-8211beb2a86f TargetEnvironmentName = "Restored Environment" TargetSecurityGroupId = "204162d5-59db-40c2-9788-2cda6b063f2b" RestorePointDateTime = $datetime.ToString("yyyy-MM-dd HH:mm:ss") SkipAuditData: true }

Parameters

-ApiVersion

The api version to call with.

Parameter properties

Type:	String
Default value:	2019-05-01
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	5
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-EnvironmentName

The target environment ID.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-RestoreToRequestDefinition

The restore request definition object.

Parameter properties

Type:	Object
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-TimeoutInMinutes

The timeout setting in minutes.

Parameter properties

Type:	Int32
Default value:	10080
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	4
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WaitUntilFinished

If set to true, the cmdlet doesn't return until completed.

Parameter properties

Type:	Boolean
Default value:	True
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	3
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

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