Edit

Share via

Get-EntraBetaApplicationProxyConnector

  • Reference
Module:
Microsoft.Entra.Beta

The Get-EntraBetaApplicationProxyConnector cmdlet a list of all connectors, or if specified, details of a specific connector.

Syntax

Get-EntraBetaApplicationProxyConnector
   [-All]
   [-Top <Int32>]
   [-Filter <String>]
   [<CommonParameters>]
Get-EntraBetaApplicationProxyConnector
   [-SearchString <String>]
   [-All]
   [<CommonParameters>]
Get-EntraBetaApplicationProxyConnector
   -OnPremisesPublishingProfileId <String>
   [-All]
   [<CommonParameters>]

Description

The Get-EntraBetaApplicationProxyConnector cmdlet retrieves the details for a given connector. If no connectorId is specified, it retrieves all the connectors assigned to the tenant.

Examples

Example 1: Retrieve all connectors

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

Id                                   DeletedDateTime
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb

This command Retrieve all connectors.

Example 2: Retrieve information for a specific connector

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraBetaApplicationProxyConnector -OnPremisesPublishingProfileId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'

Id                                   DeletedDateTime
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb

This example demonstrates how to Retrieve information for a specific connector.

  • OnPremisesPublishingProfileId parameter specifies the connector ID.

Example 3: Retrieve information for a top one connector

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraBetaApplicationProxyConnector -Top 1

Id                                   DeletedDateTime
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb

This example demonstrates how to Retrieve information for a top one connector. You can use -Limit as an alias for -Top.

Example 4: Retrieve information with SearchString parameter

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraBetaApplicationProxyConnector -SearchString 'Entra PowerShell AppProxy Connector'

Id                                   DeletedDateTime
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb

This example demonstrates how to Retrieve information using SearchString.

Example 5: Retrieve information using machineName property

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraBetaApplicationProxyConnector -Filter "machineName eq 'AppProxy Machine'"

Id                                   DeletedDateTime
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb

This example demonstrates how to Retrieve information using machineName property.

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

-OnPremisesPublishingProfileId

The ID of the specific connector. 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 details.

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

-SearchString

Specifies a 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