Skip to content

Get-AzEventHubPrivateEndpointConnection.md

Latest commit

 

History

History
197 lines (151 loc) · 5.12 KB

Get-AzEventHubPrivateEndpointConnection.md

File metadata and controls

197 lines (151 loc) · 5.12 KB
Raw
external help file
Module Name Az.EventHub
online version https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubprivateendpointconnection
schema 2.0.0

Get-AzEventHubPrivateEndpointConnection

SYNOPSIS

Gets a description for the specified Private Endpoint Connection name.

SYNTAX

List (Default)

Get-AzEventHubPrivateEndpointConnection -NamespaceName <String> -ResourceGroupName <String>
 [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]

Get

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

GetViaIdentity

Get-AzEventHubPrivateEndpointConnection -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>]
 [<CommonParameters>]

GetViaIdentityNamespace

Get-AzEventHubPrivateEndpointConnection -Name <String> -NamespaceInputObject <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: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

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

-InputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity
Parameter Sets: GetViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The PrivateEndpointConnection name

Type: System.String
Parameter Sets: Get, GetViaIdentityNamespace
Aliases: PrivateEndpointConnectionName

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

-NamespaceInputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity
Parameter Sets: GetViaIdentityNamespace
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-NamespaceName

The Namespace name

Type: System.String
Parameter Sets: Get, List
Aliases:

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

-ResourceGroupName

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

Type: System.String
Parameter Sets: Get, List
Aliases:

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

-SubscriptionId

The ID of the target subscription.

Type: System.String[]
Parameter Sets: Get, List
Aliases:

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

CommonParameters

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

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IPrivateEndpointConnection

NOTES

RELATED LINKS

https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx

https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx