Skip to content

Get-PowerApp-Admin

PowerApps Admin: Retrieves apps

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

[CmdletBinding(DefaultParameterSetName = "Filter")]
Param(
    [Parameter(Mandatory = $true, ParameterSetName = "Filter")]
    [Parameter(Mandatory = $true, ParameterSetName = "User")]
    [Parameter(Mandatory = $true, ParameterSetName = "App")]
    [pscredential]$PACredential,

    [Parameter(Mandatory = $true, ParameterSetName = "App")]
    [string]$AppName,

    [Parameter(Mandatory = $true, ParameterSetName = "App")]
    [string]$Environment,

    [Parameter(Mandatory = $true, ParameterSetName = "User")]
    [string]$Owner,

    [Parameter(ParameterSetName = "Filter")]
    [Parameter(ParameterSetName = "App")]
    [Parameter(ParameterSetName = "User")]
    [string]$ApiVersion,

    [Parameter(ParameterSetName = "Filter")]
    [Parameter(ParameterSetName = "User")]
    [string]$EnvironmentName,

    [Parameter(ParameterSetName = "Filter")]
    [Parameter(ParameterSetName = "User")]
    [string]$Filter,

    [Parameter(ParameterSetName = "Filter")]
    [Parameter(ParameterSetName = "User")]
    [Parameter(ParameterSetName = "App")]
    [ValidateSet('*', 'DisplayName', 'AppName', 'EnvironmentName', 'CreatedTime', 'LastModifiedTime', 'IsFeaturedApp', 'IsHeroApp', 'BypassConsent', 'Owner', 'UnpublishedAppDefinition', 'Internal')]
    [string[]]$Properties = @('DisplayName', 'AppName', 'EnvironmentName', 'LastModifiedTime', 'Owner')
)

Process {
    try {
        ConnectPowerApps -PAFCredential $PACredential
        $getArgs = @{ ErrorAction = 'Stop' }
        if ($PSCmdlet.ParameterSetName -eq "App") { $getArgs.Add('AppName', $AppName); $getArgs.Add('EnvironmentName', $Environment) }
        elseif ($PSCmdlet.ParameterSetName -eq "User") { $getArgs.Add('Owner', $Owner) }
        if ($PSBoundParameters.ContainsKey('ApiVersion')) { $getArgs.Add('ApiVersion', $ApiVersion) }
        if ($PSBoundParameters.ContainsKey('EnvironmentName')) { $getArgs.Add('EnvironmentName', $EnvironmentName) }
        if ($PSBoundParameters.ContainsKey('Filter')) { $getArgs.Add('Filter', $Filter) }
        $result = Get-AdminPowerApp @getArgs -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 for authentication

Find a specific app by name

The app's environment (required for AppName lookup)

Filter by app owner (email or object ID)

API version to call

Limit to apps in a specific environment

Find apps by wildcard filter

Properties to retrieve. Use * for all.

An interactive directory of PowerShell scripts.