Get-AdminPowerAppConnector

Reference

Module:: Microsoft.PowerApps.Administration.PowerShell

Returns information about 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

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.

The Get-AdminConnector cmdlet looks up information about one or more custom connectors, depending on parameters.

Examples

EXAMPLE 1

Get-AdminConnector

Returns all custom connectors from all environments where the calling user is an Environment Admin. For Global admins, this command searches across all environments in the tenant.

EXAMPLE 2

Get-AdminConnector *customapi*

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

EXAMPLE 3

Get-AdminConnector -CreatedBy john@contoso.com

Returns all apps created by the user with an email of "john@contoso.com" from all environments where the calling user is an Environment Admin. For Global admins, this command searches across all environments in the tenant.

EXAMPLE 4

Get-AdminConnector -EnvironmentName [Guid]

Finds custom connectors within the specified environment.

EXAMPLE 5

Get-AdminConnector -ConnectorName shared_customapi2.[Guid]

Finds all custom connectors created with the name/Id shared_customapi2.[Guid] from all environments where the calling user is an Environment Admin. For Global admins, this command searches across all environments in the tenant.

EXAMPLE 6

Get-AdminConnector -ConnectorName shared_customapi2.[Guid] -EnvironmentName [Guid]

Finds connections within the specified environment that are created against the connector with the name/Id shared_customapi2.[Guid].

EXAMPLE 7

Get-AdminConnector *customapi* -EnvironmentName [Guid]

Finds all connections within the specified environment that contain the string "customapi" in the display name.

Parameters

-ApiVersion

Version of Power Apps API to use.

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

-ConnectorName

Name of the custom connector to get.

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

-CreatedBy

Limit custom connectors returned to those created by the specified user (email or AAD Principal object ID).

Type:	String
Position:	Named
Default value:	None
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
Accept pipeline input:	True
Accept wildcard characters:	False

-Filter

Finds custom connector matching the specified filter. Wildcards are supported.

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