Skip to content

Get-AzEventHubCluster.md

Latest commit

 

History

History
180 lines (139 loc) · 4.37 KB

Get-AzEventHubCluster.md

File metadata and controls

180 lines (139 loc) · 4.37 KB
Raw
external help file
Module Name Az.EventHub
online version https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhubcluster
schema 2.0.0

Get-AzEventHubCluster

SYNOPSIS

Gets the resource description of the specified Event Hubs Cluster.

SYNTAX

List (Default)

Get-AzEventHubCluster [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]

Get

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

Get1

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

GetViaIdentity

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

GetViaIdentity1

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

List1

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

List2

Get-AzEventHubCluster [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]

List3

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

DESCRIPTION

Gets the resource description of the specified Event Hubs Cluster.

EXAMPLES

Example 1: Get an EventHub cluster

Get-AzEventHubCluster -ResourceGroupName myResourceGroup -Name DefaultCluster-11
Capacity                     : 1
CreatedAt                    : 2022-08-29T09:38:30.453Z
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/DefaultCluster-11
Location                     : australiaeast
MetricId                     : PROD-00-000
Name                         : DefaultCluster-11
ResourceGroupName            : myResourceGroup
SkuName                      : Dedicated
Status                       :
SupportsScaling              : False
Tag                          : {}

Gets details of EventHubs dedicated cluster by the name DefaultCluster-11.

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, GetViaIdentity1
Aliases:

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

-Name

The name of the Event Hubs Cluster.

Type: System.String
Parameter Sets: Get, Get1
Aliases: ClusterName

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, Get1, List1, List3
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, Get1, List, List1, List2, List3
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.ICluster

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IClusterAutoGenerated

NOTES

RELATED LINKS