Set-​Azure​Rm​Event​Hub

Updates the specified Event Hub.

Syntax

Set-AzureRmEventHub
   [-ResourceGroupName] <String>
   [-NamespaceName] <String>
   [-EventHubName] <String>
   [[-EventHubObj] <EventHubAttributes>]
   [-Confirm]
   [-WhatIf]
   [-messageRetentionInDays <Int64>]
   [-partitionCount <Int64>]
   [<CommonParameters>]

Description

The Set-AzureRmEventHub cmdlet updates the properties of the specified Event Hub.

Examples

Example 1

PS C:\> Set-AzureRmEventHub -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -EventHubObj MyCreatedEventHub -messageRetentionInDays 4 -partitionCount 2

Updates the Event Hub MyEventHubName represented by the MyCreatedEventHub object, setting the message retention period to 4 days, and the number of partitions to 2.

Required Parameters

-EventHubName

The Event Hub name.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-EventHubObj

The Event Hubs object.

Type:EventHubAttributes
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
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:False
Accept pipeline input:False
Accept wildcard characters:False
-messageRetentionInDays

Event Hub message retention period, in days.

Type:Int64
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-partitionCount

Number of partitions on this Event Hub.

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

Inputs

System.String

Outputs

Microsoft.Azure.Commands.EventHub.Models.EventHubAttributes