Set-AzEventHubCluster
Sets an EventHub Cluster
Syntax
Set-AzEventHubCluster
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Capacity <Int32>]
[-Tag <ITrackedResourceTags>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzEventHubCluster
-InputObject <IEventHubIdentity>
[-Capacity <Int32>]
[-Tag <ITrackedResourceTags>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Sets an EventHub Cluster
Examples
Example 1: Update EventHubs dedicated cluster
Set-AzEventHubCluster -ResourceGroupName myResourceGroup -Name myCluster -Capacity 3
Capacity : 3
CreatedAt : 2022-08-29T09:38:30.453Z
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/myCluster
Location : australiaeast
MetricId : PROD-00-000
Name : myCluster
ResourceGroupName : myResourceGroup
SkuName : Dedicated
Status :
SupportsScaling : False
Tag : {}
Updates the capacity of an EventHubs dedicated cluster to 3.
Example 2: Update EventHubs dedicated cluster using InputObject parameter set
$cluster = Get-AzEventHubCluster -ResourceGroupName myResourceGroup -Name myCluster
Set-AzEventHubCluster -InputObject $cluster -Capacity 3
Capacity : 3
CreatedAt : 2022-08-29T09:38:30.453Z
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/myCluster
Location : australiaeast
MetricId : PROD-00-000
Name : myCluster
ResourceGroupName : myResourceGroup
SkuName : Dedicated
Status :
SupportsScaling : False
Tag : {}
Updates the capacity of an EventHubs dedicated cluster to 3.
Parameters
-AsJob
Run the command as a job
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Capacity
The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
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 EventHub Dedicated Cluster
Type: | String |
Aliases: | ClusterName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
Type: | String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tag
Resource tags.
Type: | ITrackedResourceTags |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |