Share via


Get-AdminPowerAppEnvironment

Returns information about one or more PowerApps environments where the calling uses is an Environment Admin. If the calling user is a tenant admin, all environments within the tenant will be returned.

Syntax

Filter (Default)

Get-AdminPowerAppEnvironment
    [[-Filter] <String[]>]
    [-CreatedBy <String>]
    [-ApiVersion <String>]
    [-ReturnCdsDatabaseType <Boolean>]
    [-GetProtectedEnvironment]
    [-InstanceId <String>]
    [-EnvironmentSku <String>]
    [-Capacity]
    [-GetGenerativeAiSettings]
    [<CommonParameters>]

User

Get-AdminPowerAppEnvironment
    [[-Filter] <String[]>]
    -CreatedBy <String>
    [<CommonParameters>]

Name

Get-AdminPowerAppEnvironment
    [-EnvironmentName <String>]
    [-ApiVersion <String>]
    [-ReturnCdsDatabaseType <Boolean>]
    [-GetProtectedEnvironment]
    [-InstanceId <String>]
    [-EnvironmentSku <String>]
    [-Capacity]
    [-GetGenerativeAiSettings]
    [<CommonParameters>]

Default

Get-AdminPowerAppEnvironment
    [-Default]
    [<CommonParameters>]

Description

The Get-AdminPowerAppEnvironment cmdlet looks up information about one or more environments depending on parameters. Use Get-Help Get-AdminPowerAppEnvironment -Examples for more detail.

Examples

EXAMPLE 1

Get-AdminPowerAppEnvironment

Finds all environments within the tenant where the user is an Environment Admin.

EXAMPLE 2

Get-AdminPowerAppEnvironment -EnvironmentName 3c2f7648-ad60-4871-91cb-b77d7ef3c239

Finds environment 3c2f7648-ad60-4871-91cb-b77d7ef3c239.

EXAMPLE 3

Get-AdminPowerAppEnvironment *Test*

Finds all environments that contain the string "Test" in their display name where the user is an Environment Admin.

EXAMPLE 4

Get-AdminPowerAppEnvironment -CreatedBy 7557f390-5f70-4c93-8bc4-8c2faabd2ca0

Finds all environments that were created by the user with an object of 7557f390-5f70-4c93-8bc4-8c2faabd2ca0.

Parameters

-ApiVersion

The api version to call with. Default 2018-01-01.

Parameter properties

Type:String
Default value:2016-11-01
Supports wildcards:False
DontShow:False

Parameter sets

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

-Capacity

If it is true, capacity information is returned.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

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

-CreatedBy

Limit environments returned to only those created by the specified user (you can specify a email address or object id)

Parameter properties

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

Parameter sets

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

-Default

Finds the default environment.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

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

-EnvironmentName

Finds a specific environment.

Parameter properties

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

Parameter sets

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

-EnvironmentSku

Environment Sku.

Parameter properties

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

Parameter sets

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

-Filter

Finds environments matching the specified filter (wildcards supported).

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-GetGenerativeAiSettings

If it is true, generative AI settings are returned.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

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

-GetProtectedEnvironment

Get protected environments if it is defined.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

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

-InstanceId

Instance Id.

Parameter properties

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

Parameter sets

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

-ReturnCdsDatabaseType

If it is true, CdsDatabaseType is returned.

Parameter properties

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

Parameter sets

Filter
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Name
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.