Get-​Azure​Rm​Event​Hub

Gets the details of a single Event Hub, or gets a list of Event Hubs.

Syntax

Get-AzureRmEventHub
   [-ResourceGroupName] <String>
   [-NamespaceName] <String>
   [[-EventHubName] <String>]
   [<CommonParameters>]

Description

The Get-AzureRmEventHub cmdlet returns either the details of an Event Hub, or a list of all Event Hubs in the current namespace. If the Event Hub name is provided, the details of a single Event Hub are returned. If an Event Hub name is not provided, a list of all Event Hubs in the specified namespace is returned.

Examples

Example 1

PS C:\> Get-AzureRmEventHub -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName

Returns the details of the Event Hub EventHubName.

Example 2

PS C:\> Get-AzureRmEventHub -ResourceGroup MyResourceGroupName -NamespaceName MyNamespaceName

Returns a list of Event Hubs in the namespace MyNamespaceName.

Required Parameters

-NamespaceName

The Event Hubs namespace name.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Resource group name.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-EventHubName

The Event Hub name.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Inputs

System.String

Outputs

System.Collections.Generic.List`1[[Microsoft.Azure.Commands.EventHub.Models.EventHubAttributes, Microsoft.Azure.Commands.EventHub, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]