Get-AzEventHubCluster
Gets the resource description of the specified Event Hubs Cluster.
Syntax
Get-AzEventHubCluster
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzEventHubCluster
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzEventHubCluster
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzEventHubCluster
-InputObject <IEventHubIdentity>
[-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: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IEventHubIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the Event Hubs Cluster.
| Type: | String |
| Aliases: | ClusterName |
| 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 |