Set-AdminPowerAppEnvironmentRuntimeState
Updates the environment run time state.
Syntax
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 AdminModeSets the environment '8d996ece-8558-4c4e-b459-a51b3beafdb4' runtime state to AdminMode.
Parameters
-ApiVersion
Specifies the Api version that is called.
| Type: | String |
| Position: | Named |
| Default value: | 2021-04-01 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BackgroundOperationsState
The environment background operations state. It can be Enabled or Disabled. The default is Enabled.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnvironmentName
The environment ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RuntimeState
The environment runtime state. It can be Enabled, AdminMode, Disabled, Warning. The default is Enabled.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeoutInMinutes
The client timeout setting in minutes.
| Type: | Int32 |
| Position: | Named |
| Default value: | 10080 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WaitUntilFinished
Default is True. If set to True, then the cmdlet doesn't return until the operation completes.
| Type: | Boolean |
| Position: | Named |
| Default value: | True |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |