Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-AzEventHub
- Module:
- Az.EventHub Module
create a new Event Hub as a nested resource within a Namespace.
Syntax
CreateExpanded (Default)
New-AzEventHub
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-ArchiveNameFormat <String>]
[-BlobContainer <String>]
[-CaptureEnabled]
[-CleanupPolicy <String>]
[-DestinationName <String>]
[-Encoding <String>]
[-IdentityType <String>]
[-IntervalInSeconds <Int32>]
[-MinCompactionLagInMin <Int64>]
[-PartitionCount <Int64>]
[-RetentionTimeInHour <Int64>]
[-SizeLimitInBytes <Int32>]
[-SkipEmptyArchive]
[-Status <String>]
[-StorageAccountResourceId <String>]
[-TimestampType <String>]
[-TombstoneRetentionTimeInHour <Int32>]
[-UserAssignedIdentityId <String>]
[-UserMetadata <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentityNamespaceExpanded
New-AzEventHub
-Name <String>
-NamespaceInputObject <IEventHubIdentity>
[-ArchiveNameFormat <String>]
[-BlobContainer <String>]
[-CaptureEnabled]
[-CleanupPolicy <String>]
[-DestinationName <String>]
[-Encoding <String>]
[-IdentityType <String>]
[-IntervalInSeconds <Int32>]
[-MinCompactionLagInMin <Int64>]
[-PartitionCount <Int64>]
[-RetentionTimeInHour <Int64>]
[-SizeLimitInBytes <Int32>]
[-SkipEmptyArchive]
[-Status <String>]
[-StorageAccountResourceId <String>]
[-TimestampType <String>]
[-TombstoneRetentionTimeInHour <Int32>]
[-UserAssignedIdentityId <String>]
[-UserMetadata <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaIdentityNamespace
New-AzEventHub
-Name <String>
-NamespaceInputObject <IEventHubIdentity>
-Parameter <IEventhub>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
create a new Event Hub as a nested resource within a Namespace.
Examples
Example 1: Create an EventHub entity
New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -RetentionTimeInHour 168 -PartitionCount 5 -CleanupPolicy Delete
ArchiveNameFormat :
BlobContainer :
CaptureEnabled :
CleanupPolicy : Delete
CreatedAt : 4/25/2023 3:55:45 AM
DataLakeAccountName :
DataLakeFolderPath :
DataLakeSubscriptionId :
DestinationName :
Encoding :
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds :
Location : eastus
MessageRetentionInDay : 7
Name : myEventHub
PartitionCount : 5
PartitionId : {0, 1, 2, 3�}
ResourceGroupName : myResourceGroup
RetentionTimeInHour : 168
SizeLimitInBytes :
SkipEmptyArchive :
Status : Active
StorageAccountResourceId :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt : 4/25/2023 3:55:46 AM
Creates a new eventhub entity myEventHub on namespace myNamespace with CleanupPolicy Delete.
Example 2: Create EventHub with Capture Enabled
New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -ArchiveNameFormat "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" -BlobContainer container -CaptureEnabled -DestinationName EventHubArchive.AzureBlockBlob -Encoding Avro -IntervalInSeconds 600 -SizeLimitInBytes 11000000 -SkipEmptyArchive -StorageAccountResourceId "/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount -CleanupPolicy Delete"
ArchiveNameFormat : {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}
BlobContainer : container
CaptureEnabled : true
CreatedAt : 9/1/2022 5:55:46 AM
DataLakeAccountName :
DataLakeFolderPath :
DataLakeSubscriptionId :
DestinationName :
Encoding : Avro
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myFirstEventHub
IntervalInSeconds : 600
Location : centralus
MessageRetentionInDays : 6
Name : myFirstEventHub
PartitionCount : 5
PartitionId : {0}
ResourceGroupName : myResourceGroup
RetentionTimeInHour : 24
SizeLimitInBytes : 11000000
SkipEmptyArchive : true
Status : Active
Creates a new eventhub entity myEventHub on namespace myNamespace with capture enabled.
Example 3: Create an EventHub entity
New-AzEventHub -Name myEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -CleanupPolicy Compact
ArchiveNameFormat :
BlobContainer :
CaptureEnabled :
CleanupPolicy : Compact
CreatedAt : 4/25/2023 4:05:57 AM
DataLakeAccountName :
DataLakeFolderPath :
DataLakeSubscriptionId :
DestinationName :
Encoding :
Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds :
Location : eastus
MessageRetentionInDay : 9223372036854775807
Name : myEventHub
PartitionCount : 4
PartitionId : {0, 1, 2, 3}
ResourceGroupName : myResourceGroup
RetentionTimeInHour :
SizeLimitInBytes :
SkipEmptyArchive :
Status : Active
StorageAccountResourceId :
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt : 4/25/2023 4:05:58 AM
Creates a new eventhub entity myEventHub on namespace myNamespace with CleanupPolicy Compact.
Parameters
-ArchiveNameFormat
Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BlobContainer
Blob container Name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CaptureEnabled
A value that indicates whether capture description is enabled.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CleanupPolicy
Enumerates the possible values for cleanup policy
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
Parameter sets
-DestinationName
Name for capture destination
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Encoding
Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IdentityType
Type of Azure Active Directory Managed Identity.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IntervalInSeconds
The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-MinCompactionLagInMin
The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.
Parameter properties
| Type: | Int64 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
The Event Hub name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | EventHubName |
Parameter sets
-NamespaceInputObject
Identity Parameter
Parameter properties
| Type: | IEventHubIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NamespaceName
The Namespace name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Parameter
Single item in List or Get Event Hub operation
Parameter properties
| Type: | IEventhub |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PartitionCount
Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.
Parameter properties
| Type: | Int64 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
Name of the resource group within the azure subscription.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RetentionTimeInHour
Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type.
Parameter properties
| Type: | Int64 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SizeLimitInBytes
The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkipEmptyArchive
A value that indicates whether to Skip Empty Archives
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Status
Enumerates the possible values for the status of the Event Hub.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-StorageAccountResourceId
Resource id of the storage account to be used to create the blobs
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SubscriptionId
Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Parameter properties
| Type: | String |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TimestampType
Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TombstoneRetentionTimeInHour
Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UserAssignedIdentityId
ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UserMetadata
Gets and Sets Metadata of User.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
IEventhub
IEventHubIdentity
Outputs
IEventhub
Azure PowerShell
Feedback
Was this page helpful?