Get-AdminPowerAppConnector

  • Reference
Module:
Microsoft.PowerApps.Administration.PowerShell

Returns information about one or more custom connectors.

Syntax

Get-AdminPowerAppConnector
   [[-Filter] <String[]>]
   [-EnvironmentName <String>]
   [-CreatedBy <String>]
   [-ApiVersion <String>]
   [<CommonParameters>]
Get-AdminPowerAppConnector
   [[-Filter] <String[]>]
   [-EnvironmentName <String>]
   -CreatedBy <String>
   [-ApiVersion <String>]
   [<CommonParameters>]
Get-AdminPowerAppConnector
   [-EnvironmentName <String>]
   -ConnectorName <String>
   [-ApiVersion <String>]
   [<CommonParameters>]

Description

The Get-AdminConnector cmdlet looks up information about one or more custom connectors depending on parameters. Use Get-Help Get-AdminConnector -Examples for more detail.

Examples

EXAMPLE 1

Get-AdminConnector

Returns all custom connector from all environments where the calling user is an Environment Admin. For Global admins, this will search across all environments in the tenant.

EXAMPLE 2

Get-AdminConnector *customapi*

Returns all custom connectors with the text "customapi" in the name/display name from all environments where the calling user is an Environment Admin For Global admins, this will search across all environments in the tenant.

EXAMPLE 3

Get-AdminConnector -CreatedBy foo@bar.onmicrosoft.com

Returns all apps created by the user with an email address of "foo@bar.onmicrosoft.com" from all environment where the calling user is an environment admin. For global admins, this will search across all environments in the tenant.

EXAMPLE 4

Get-AdminConnector -EnvironmentName 0fc02431-15fb-4563-a5ab-8211beb2a86f

Finds custom connectors within the 0fc02431-15fb-4563-a5ab-8211beb2a86f environment.

EXAMPLE 5

Get-AdminConnector -ConnectorName shared_customapi2.5f0629412a7d1fe83e.5f6f049093c9b7a698

Finds all custom connectors created with name shared_customapi2.5f0629412a7d1fe83e.5f6f049093c9b7a698 from all environments where the calling user is an environment admin. For global admins, this searches across all environments in the tenant.

EXAMPLE 6

Get-AdminConnector -ConnectorName shared_customapi2.5f0629412a7d1fe83e.5f6f049093c9b7a698 -EnvironmentName 0fc02431-15fb-4563-a5ab-8211beb2a86f

Finds connections within the 0fc02431-15fb-4563-a5ab-8211beb2a86f environment that are created against the shared_customapi2.5f0629412a7d1fe83e.5f6f049093c9b7a698.

EXAMPLE 7

Get-AdminConnector *customapi* -EnvironmentName 0fc02431-15fb-4563-a5ab-8211beb2a86f

Finds all connections in environment 0fc02431-15fb-4563-a5ab-8211beb2a86f that contain the string "customapi" in their display name.

Parameters

-ApiVersion

The api version to call with. Default 2017-05-01

Type:String
Position:Named
Default value:2017-05-01
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectorName

Limit custom connectors returned to those of a specified connector.

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

-CreatedBy

Limit custom connectors returned to those created by the specified user (email or Microsoft Entra ID principal object ID).

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

-EnvironmentName

Limit custom connectors returned to those in a specified environment.

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

-Filter

Finds custom connector matching the specified filter (wildcards supported).

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False