Set-AdminPowerAppEnvironmentRuntimeState

Module:

Microsoft.PowerApps.Administration.PowerShell Module

Updates the environment run time state.

Syntax

Default (Default)

Set-AdminPowerAppEnvironmentRuntimeState
    -EnvironmentName <String>
    -RuntimeState <String>
    [-BackgroundOperationsState <String>]
    [-WaitUntilFinished <Boolean>]
    [-TimeoutInMinutes <Int32>]
    [-ApiVersion <String>]
    [<CommonParameters>]

Description

The Set-AdminPowerAppEnvironmentRuntimeState cmdlet updates the administration mode field of the specified environment to determine the runtime state. When an environment is in administration mode (AdminMode), only users with System Administrator or System Customizer security roles can sign in to the environment. Use Get-Help Set-AdminPowerAppEnvironmentRuntimeState -Examples for more detail.

Examples

EXAMPLE 1

Set-AdminPowerAppEnvironmentRuntimeState -EnvironmentName 8d996ece-8558-4c4e-b459-a51b3beafdb4 -RuntimeState AdminMode

Sets the environment '8d996ece-8558-4c4e-b459-a51b3beafdb4' runtime state to AdminMode.

Parameters

-ApiVersion

Specifies the Api version that is called.

Parameter properties

Type:	String
Default value:	2021-04-01
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-BackgroundOperationsState

The environment background operations state. It can be Enabled or Disabled. The default is Enabled.

Parameter properties

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

Parameter sets

(All)

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

-EnvironmentName

The environment ID.

Parameter properties

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

Parameter sets

(All)

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

-RuntimeState

The environment runtime state. It can be Enabled, AdminMode, Disabled, Warning. The default is Enabled.

Parameter properties

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

Parameter sets

(All)

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

-TimeoutInMinutes

The client timeout setting in minutes.

Parameter properties

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

Parameter sets

(All)

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

-WaitUntilFinished

Default is True. If set to True, then the cmdlet doesn't return until the operation completes.

Parameter properties

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

Parameter sets

(All)

Position:	Named
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.