Edit

Share via

Get-EntraBetaApplicationProxyConnectorGroup

  • Reference
Module:
Microsoft.Entra.Beta

The Get-EntraBetaApplicationProxyConnectorGroup cmdlet retrieves a list of all connector groups, or if specified, details of a specific connector group.

Syntax

Get-EntraBetaApplicationProxyConnectorGroup
   [-All]
   [-Top <Int32>]
   [-Filter <String>]
   [<CommonParameters>]
Get-EntraBetaApplicationProxyConnectorGroup
   [-SearchString <String>]
   [-All]
   [<CommonParameters>]
Get-EntraBetaApplicationProxyConnectorGroup
   -Id <String>
   [-All]
   [<CommonParameters>]

Description

The Get-EntraBetaApplicationProxyConnectorGroup cmdlet retrieves a list of all connector groups, or if specified, details of the specified connector group.

Examples

Example 1: Retrieve all connector groups

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraBetaApplicationProxyConnectorGroup

Id                                   ConnectorGroupType IsDefault Name                       Region
--                                   ------------------ --------- ----                       ------
bbbbbbbb-1111-2222-3333-cccccccccccc applicationProxy   False     Test                       eur
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb applicationProxy   True      Default                    eur

This example retrieves all connector groups.

Example 2: Retrieve a specific connector group

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraBetaApplicationProxyConnectorGroup -Id 'bbbbbbbb-1111-2222-3333-cccccccccccc'

Name                           Value
----                           -----
Id                                   ConnectorGroupType IsDefault Name                       Region
--                                   ------------------ --------- ----                       ------
bbbbbbbb-1111-2222-3333-cccccccccccc applicationProxy   False     Test                       eur

This example retrieves a specific connector group.

  • Id parameter specifies the connector group ID.

Example 3: Retrieve Top one connector groups

Get-EntraBetaApplicationProxyConnectorGroup -Top 1

Id                                   ConnectorGroupType IsDefault Name                       Region
--                                   ------------------ --------- ----                       ------
bbbbbbbb-1111-2222-3333-cccccccccccc applicationProxy   False     Test                       eur

This example retrieves top one connector groups. You can use -Limit as an alias for -Top.

Example 4: Retrieve a connector groups with filter parameter

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraBetaApplicationProxyConnectorGroup -Filter "name eq 'Default'"

Id                                   ConnectorGroupType IsDefault Name                       Region
--                                   ------------------ --------- ----                       ------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb applicationProxy   True      Default                    eur

This example retrieves a connector groups with filter parameter.

Example 5: Retrieve a connector groups with String parameter

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraBetaApplicationProxyConnectorGroup -SearchString 'Test'

Id                                   ConnectorGroupType IsDefault Name                       Region
--                                   ------------------ --------- ----                       ------
bbbbbbbb-1111-2222-3333-cccccccccccc applicationProxy   False     Test                       eur

This example retrieves a connector groups with String parameter.

Parameters

-All

List all pages.

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

Specifies an OData v4.0 filter statement. This parameter controls which objects are returned. Details on querying with oData can be found here: https://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol/#queryingcollections

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

-Id

The ID of the specific connector group. You can find this ID by running the command without this parameter to get the desired ID, or by going into the portal and viewing connector group details.

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

-SearchString

Specifies the search string.

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

-Top

Specifies the maximum number of records to return.

Type:System.Int32
Aliases:Limit
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

System.String

System.Nullable`1[[System. Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Outputs

System.Object