Get-AzEventHub

Reference

Module:: Az.EventHub

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

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Get-AzEventHub
   [-ResourceGroupName] <String>
   [-Namespace] <String>
   [[-Name] <String>]
   [-MaxCount <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventHub
   [[-Name] <String>]
   [-NamespaceObject] <PSNamespaceAttributes>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzEventHub 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: specified EventHub

Get-AzEventHub -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName

Returns the details of the Event Hub `MyEventHubName`.

Example 2: List of EventHub in specified Namespace

Get-AzEventHub -ResourceGroup MyResourceGroupName -NamespaceName MyNamespaceName

Returns a list of Event Hubs in the namespace `MyNamespaceName`.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxCount

Determine the maximum number of EventHubs to return.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

EventHub Name

Type:	String
Aliases:	EventHubName
Position:	2
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Namespace

Namespace Name

Type:	String
Aliases:	NamespaceName
Position:	1
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-NamespaceObject

Namespace object

Type:	PSNamespaceAttributes
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Resource Group Name

Type:	String
Position:	0
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

PSEventHubAttributes