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
Get-AdminPowerAppEnvironment
[[-Filter] <String[]>]
[-CreatedBy <String>]
[-ApiVersion <String>]
[-ReturnCdsDatabaseType <Boolean>]
[-GetProtectedEnvironment]
[-InstanceId <String>]
[-EnvironmentSku <String>]
[-Capacity]
[-GetGenerativeAiSettings]
[<CommonParameters>] Get-AdminPowerAppEnvironment
[[-Filter] <String[]>]
-CreatedBy <String>
[<CommonParameters>] Get-AdminPowerAppEnvironment
[-EnvironmentName <String>]
[-ApiVersion <String>]
[-ReturnCdsDatabaseType <Boolean>]
[-GetProtectedEnvironment]
[-InstanceId <String>]
[-EnvironmentSku <String>]
[-Capacity]
[-GetGenerativeAiSettings]
[<CommonParameters>] 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-AdminPowerAppEnvironmentFinds all environments within the tenant where the user is an Environment Admin.
EXAMPLE 2
Get-AdminPowerAppEnvironment -EnvironmentName 3c2f7648-ad60-4871-91cb-b77d7ef3c239Finds 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-8c2faabd2ca0Finds 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.
| Type: | String |
| Position: | Named |
| Default value: | 2016-11-01 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Capacity
If it is true, capacity information is returned.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| 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 |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Default
Finds the default environment.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnvironmentName
Finds a specific environment.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EnvironmentSku
Environment Sku.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Finds environments matching the specified filter (wildcards supported).
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GetGenerativeAiSettings
If it is true, generative AI settings are returned.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GetProtectedEnvironment
Get protected environments if it is defined.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InstanceId
Instance Id.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReturnCdsDatabaseType
If it is true, CdsDatabaseType is returned.
| Type: | Boolean |
| Position: | Named |
| Default value: | True |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |