Modifier

Partager via

Get-AzEventHubPrivateEndpointConnection

  • Reference
Module:
Az.EventHub

Gets a description for the specified Private Endpoint Connection name.

Syntax

Get-AzEventHubPrivateEndpointConnection
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzEventHubPrivateEndpointConnection
   -Name <String>
   -NamespaceInputObject <IEventHubIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzEventHubPrivateEndpointConnection
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzEventHubPrivateEndpointConnection
   -InputObject <IEventHubIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets a description for the specified Private Endpoint Connection name.

Examples

Example 1: Get an Event Hub Namespace Private Endpoint Connection

Get-AzEventHubPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name 00000000000

ConnectionState              : Approved
Description                  :
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/privateEndpointC
                               onnections/00000000000
Location                     : Australia East
Name                         : 00000000000
PrivateEndpointId            : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/privateEndpointName
ProvisioningState            : Succeeded
ResourceGroupName            : myResourceGroup

Gets details of private endpoint connection 00000000000 created under EventHub namespace myNamespace.

Example 2: List all private endpoint connections on an EventHub namespace

Get-AzEventHubPrivateEndpointConnection -ResourceGroupName myResourceGroup -NamespaceName myNamespace

Lists all private endpoint connections of EventHub namespace myNamespace.

Parameters

-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

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

-Name

The PrivateEndpointConnection name

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

-NamespaceInputObject

Identity Parameter

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

-NamespaceName

The Namespace name

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

-ResourceGroupName

Name of the resource group within the azure subscription.

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

-SubscriptionId

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

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

Inputs

IEventHubIdentity

Outputs

IPrivateEndpointConnection