Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-EntraBetaApplicationProxyConnectorGroup

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

Syntax

GetQuery (Default)

Get-EntraBetaApplicationProxyConnectorGroup

 [-All]
 [-Top <Int32>]
 [-Filter <String>]
 [<CommonParameters>]

GetByValue

Get-EntraBetaApplicationProxyConnectorGroup

 [-SearchString <String>]
 [-All]
 [<CommonParameters>]

GetById

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.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-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

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-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.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-SearchString

Specifies the search string.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Top

Specifies the maximum number of records to return.

Parameter properties

Type:System.Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Limit

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

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

Related Links


Feedback

Was this page helpful?