Skip to content

Get-Environment

PowerApps: Retrieves environments

#Requires -Version 5.1
#Requires -Modules Microsoft.PowerApps.Administration.PowerShell

[CmdletBinding()]
Param(
    [Parameter(Mandatory = $true)]
    [pscredential]$PACredential,

    [string]$EnvironmentName,
    [string]$Filter,
    [switch]$Default,
    [string]$ApiVersion,

    [ValidateSet('*', 'DisplayName', 'EnvironmentName', 'IsDefault', 'CreatedTime', 'CreatedBy', 'Location', 'LastModifiedTime', 'LastModifiedBy', 'Internal')]
    [string[]]$Properties = @('DisplayName', 'EnvironmentName', 'IsDefault', 'Location', 'LastModifiedTime')
)

Process {
    try {
        ConnectPowerApps -PAFCredential $PACredential
        $args = @{ ErrorAction = 'Stop' }
        if ($PSBoundParameters.ContainsKey('Filter')) { $args.Add('Filter', $Filter) }
        elseif ($PSBoundParameters.ContainsKey('EnvironmentName')) { $args.Add('EnvironmentName', $EnvironmentName) }
        elseif ($Default) { $args.Add('Default', $true) }
        if ($PSBoundParameters.ContainsKey('ApiVersion')) { $args.Add('ApiVersion', $ApiVersion) }
        $result = Get-AdminPowerAppEnvironment @args -ErrorAction Stop | Select-Object $Properties
        if ($null -ne $result) { foreach ($item in $result) { $item | Add-Member -NotePropertyName Timestamp -NotePropertyValue (Get-Date -Format "yyyy-MM-dd HH:mm:ss") -PassThru -Force } }
    }
    catch { throw }
    finally { DisconnectPowerApps }
}

PowerApps credentials

Find a specific environment

Filter by environment name (wildcards)

Off

Return only the default environment

API version to call

Properties to retrieve

An interactive directory of PowerShell scripts.