Skip to content

Get-Connector-Admin

PowerApps Admin: Retrieves connectors

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

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

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

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

    [Parameter(Mandatory = $true, ParameterSetName = "Connector")]
    [string]$ConnectorName,

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

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

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

    [Parameter(ParameterSetName = "Filter")]
    [Parameter(ParameterSetName = "User")]
    [Parameter(ParameterSetName = "Connector")]
    [ValidateSet('*', 'DisplayName', 'ConnectorName', 'ConnectorId', 'EnvironmentName', 'CreatedTime', 'CreatedBy', 'ApiDefinitions', 'LastModifiedTime', 'Internal')]
    [string[]]$Properties = @('DisplayName', 'ConnectorName', 'ConnectorId', 'EnvironmentName', 'LastModifiedTime')
)

Process {
    try {
        if ($Properties -contains '*') { $Properties = @('*') }
        ConnectPowerApps -PAFCredential $PACredential
        $getArgs = @{ ErrorAction = 'Stop' }
        if ($PSCmdlet.ParameterSetName -eq "Connector") { $getArgs.Add('ConnectorName', $ConnectorName) }
        elseif ($PSCmdlet.ParameterSetName -eq "User") { $getArgs.Add('CreatedBy', $UserName) }
        elseif ($PSCmdlet.ParameterSetName -eq "Filter" -and $PSBoundParameters.ContainsKey('CreatedBy')) { $getArgs.Add('CreatedBy', $CreatedBy) }
        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-AdminPowerAppConnector @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

Filter by connector creator email/ID

Filter by creator email

Find a specific connector

API version to call

Limit to connectors in an environment

Filter by connector name (wildcards)

Properties to retrieve

An interactive directory of PowerShell scripts.