< Back
New-AzureRmEventHub
Post
NAME New-AzureRmEventHub
SYNOPSIS
Creates a new Event Hub.
SYNTAX
New-AzureRmEventHub [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-InputObject
<PSEventHubAttributes>] [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmEventHub [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]
[-MessageRetentionInDays <Int64>] [-PartitionCount <Int64>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmEventHub cmdlet creates a new Azure Event Hub. To create Eventhub with Capture description properties, please follow the below
steps (Examples 2).
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with Azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSEventHubAttributes>
EventHub Input object
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MessageRetentionInDays <Int64>
Eventhub Message Retention In Days
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Eventhub Name
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Namespace <String>
Namespace Name
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PartitionCount <Int64>
Eventhub PartitionCount
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral,
PublicKeyToken=b77a5c561934e089]]
OUTPUTS
Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes
NOTES
Example 1
PS C:\\> New-AzureRmEventHub -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location WestUS -EventHubName MyEventHubName
-MessageRetentionInDays 3 -PartitionCount 2
Creates an Event Hub named `MyEventHubName` with a 3-day message retention period and two partitions, in the `WestUS` location, with resource
group `MyResourceGroupName`.
Example 2
PS C:\\> New-AzureRmEventHub -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location WestUS -EventHubName MyEventHubName
-MessageRetentionInDays 3 -PartitionCount 2
PS C:\\> $CreatedEventHub = Get-AzureRmEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName
PS C:\\> $createdEventHub.CaptureDescription = New-Object -TypeName Microsoft.Azure.Commands.EventHub.Models.CaptureDescriptionAttributes
PS C:\\> $createdEventHub.CaptureDescription.Enabled = $true
PS C:\\> $createdEventHub.CaptureDescription.IntervalInSeconds = 120
PS C:\\> $createdEventHub.CaptureDescription.Encoding = "Avro"
PS C:\\> $createdEventHub.CaptureDescription.SizeLimitInBytes = 10485763
PS C:\\> $createdEventHub.CaptureDescription.Destination.Name = "EventHubArchive.AzureBlockBlob"
PS C:\\> $createdEventHub.CaptureDescription.Destination.BlobContainer = "container"
PS C:\\> $createdEventHub.CaptureDescription.Destination.ArchiveNameFormat =
"{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"
PS C:\\> $createdEventHub.CaptureDescription.Destination.StorageAccountResourceId =
"/subscriptions/{SubscriptionId}/resourceGroups/MyResourceGroupName/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage"
PS C:\\> Set-AzureRmEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -InputObject MyCreatedEventHub
-messageRetentionInDays 4 -partitionCount 2
Creates an Event Hub named `MyEventHubName` with a 3-day message retention period, 2 partitions and CaptureDescription properties in the `WestUS`
location, with resource group `MyResourceGroupName`.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rmeventhub
SYNOPSIS
Creates a new Event Hub.
SYNTAX
New-AzureRmEventHub [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-InputObject
<PSEventHubAttributes>] [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmEventHub [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]
[-MessageRetentionInDays <Int64>] [-PartitionCount <Int64>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmEventHub cmdlet creates a new Azure Event Hub. To create Eventhub with Capture description properties, please follow the below
steps (Examples 2).
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with Azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSEventHubAttributes>
EventHub Input object
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MessageRetentionInDays <Int64>
Eventhub Message Retention In Days
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Eventhub Name
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Namespace <String>
Namespace Name
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PartitionCount <Int64>
Eventhub PartitionCount
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral,
PublicKeyToken=b77a5c561934e089]]
OUTPUTS
Microsoft.Azure.Commands.EventHub.Models.PSEventHubAttributes
NOTES
Example 1
PS C:\\> New-AzureRmEventHub -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location WestUS -EventHubName MyEventHubName
-MessageRetentionInDays 3 -PartitionCount 2
Creates an Event Hub named `MyEventHubName` with a 3-day message retention period and two partitions, in the `WestUS` location, with resource
group `MyResourceGroupName`.
Example 2
PS C:\\> New-AzureRmEventHub -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location WestUS -EventHubName MyEventHubName
-MessageRetentionInDays 3 -PartitionCount 2
PS C:\\> $CreatedEventHub = Get-AzureRmEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName
PS C:\\> $createdEventHub.CaptureDescription = New-Object -TypeName Microsoft.Azure.Commands.EventHub.Models.CaptureDescriptionAttributes
PS C:\\> $createdEventHub.CaptureDescription.Enabled = $true
PS C:\\> $createdEventHub.CaptureDescription.IntervalInSeconds = 120
PS C:\\> $createdEventHub.CaptureDescription.Encoding = "Avro"
PS C:\\> $createdEventHub.CaptureDescription.SizeLimitInBytes = 10485763
PS C:\\> $createdEventHub.CaptureDescription.Destination.Name = "EventHubArchive.AzureBlockBlob"
PS C:\\> $createdEventHub.CaptureDescription.Destination.BlobContainer = "container"
PS C:\\> $createdEventHub.CaptureDescription.Destination.ArchiveNameFormat =
"{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"
PS C:\\> $createdEventHub.CaptureDescription.Destination.StorageAccountResourceId =
"/subscriptions/{SubscriptionId}/resourceGroups/MyResourceGroupName/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage"
PS C:\\> Set-AzureRmEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -InputObject MyCreatedEventHub
-messageRetentionInDays 4 -partitionCount 2
Creates an Event Hub named `MyEventHubName` with a 3-day message retention period, 2 partitions and CaptureDescription properties in the `WestUS`
location, with resource group `MyResourceGroupName`.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rmeventhub