Get-AzKustoPrivateEndpointConnection

Module:

Az.Kusto

Gets a private endpoint connection.

Syntax

Get-AzKustoPrivateEndpointConnection
   -ClusterName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzKustoPrivateEndpointConnection
   -ClusterName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzKustoPrivateEndpointConnection
   -InputObject <IKustoIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets a private endpoint connection.

Examples

Example 1: List all Kusto PrivateEndpointConnection in a cluster by name

Get-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e"

Name                                                       Type
----                                                       ----
privateEndpointConnectionName1                             Microsoft.Kusto/Clusters/PrivateEndpointConnections
privateEndpointConnectionName2                             Microsoft.Kusto/Clusters/PrivateEndpointConnections

The above command returns all Kusto PrivateEndpointConnection in the cluster "mycluster" found in the resource group "testrg".

Example 2: Get a specific Kusto PrivateEndpointConnection by name

Get-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e" -Name "privateEndpointConnectionName"

Name                                                       Type
----                                                       ----
privateEndpointConnectionName                              Microsoft.Kusto/Clusters/PrivateEndpointConnections

The above command returns the Kusto PrivateEndpointConnection named "privateEndpointConnectionName" in the cluster "mycluster" found in the resource group "testrg".

Parameters

-ClusterName

The name of the Kusto cluster.

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

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

The name of the private endpoint connection.

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-SubscriptionId

The ID of the target subscription.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IKustoIdentity

Outputs

IPrivateEndpointConnection