Get-AdminPowerAppEnvironment

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

Syntax

Get-AdminPowerAppEnvironment
   [[-Filter] <String[]>]
   [-CreatedBy <String>]
   [-ApiVersion <String>]
   [-ReturnCdsDatabaseType <Boolean>]
   [-GetProtectedEnvironment]
   [-InstanceId <String>]
   [<CommonParameters>]
Get-AdminPowerAppEnvironment
   [[-Filter] <String[]>]
   -CreatedBy <String>
   [<CommonParameters>]
Get-AdminPowerAppEnvironment
   [-EnvironmentName <String>]
   [-ApiVersion <String>]
   [-ReturnCdsDatabaseType <Boolean>]
   [-GetProtectedEnvironment]
   [-InstanceId <String>]
   [<CommonParameters>]
Get-AdminPowerAppEnvironment
   [-Default]
   [<CommonParameters>]

Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.

The Get-AdminPowerAppEnvironment cmdlet looks up information about one or more environments. If the calling user is a tenant admin, the command returns all environments within the tenant.

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 [Guid]

Finds environment [Guid]

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 [Guid]

Finds all environments that were created by the user with an object of [Guid]

Parameters

-ApiVersion

Version of Power Apps API to use. Default 2018-01-01.

Type:String
Position:Named
Default value:2016-11-01
Accept pipeline input:False
Accept wildcard characters:False
-CreatedBy

Limit environments returned to only those created by the specified user. You can specify a email address or object ID.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Default

Finds the default environment.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-EnvironmentName

ID of the specific environment to find.

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Filter

Finds environments matching the specified filter. Wildcards are supported.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-GetProtectedEnvironment

Get protected environment if it is defined.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-InstanceId

Instance ID.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ReturnCdsDatabaseType

Returns the Common Data Service database type (Database, File, or Log).

Type:Boolean
Position:Named
Default value:True
Accept pipeline input:False
Accept wildcard characters:False