Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

New-AzEventHubNamespace

Module:: Az.EventHub Module

Creates an EventHub Namespace

Syntax

Default (Default)

New-AzEventHubNamespace
 -Name <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String>]
 -Location <String>
 [-AlternateName <String>]
 [-ClusterArmId <String>]
 [-DisableLocalAuth]
 [-RequireInfrastructureEncryption]
 [-ZoneRedundant]
 [-KeyVaultProperty <IKeyVaultProperties[]>]
 [-IdentityType <String>]
 [-UserAssignedIdentityId <String[]>]
 [-EnableAutoInflate]
 [-MaximumThroughputUnit <Int64>]
 [-MinimumTlsVersion <String>]
 [-SkuName <String>]
 [-PublicNetworkAccess <String>]
 [-SkuCapacity <Int64>]
 [-Tag <Hashtable>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Creates an EventHub Namespace

Examples

Example 1: Create a new EventHub namespace with UserAssignedIdentity Encryption

$keyVaultProperty1 = New-AzEventHubKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
$keyVaultProperty2 = New-AzEventHubKeyVaultPropertiesObject -KeyName key2 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity"

New-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity","/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" -KeyVaultProperty $keyVaultProperty1,$keyVaultProperty2

AlternateName :
ClusterArmId :
CreatedAt : 11/17/2022 2:56:32 PM
DisableLocalAuth : False
EnableAutoInflate : False
Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
IdentityType : UserAssigned
KafkaEnabled : True
KeySource : Microsoft.KeyVault
KeyVaultProperty : {{
 "identity": {
 "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
 },
 "keyName": "key1",
 "keyVaultUri": "https://testkeyvault.vault.azure.net/",
 "keyVersion": ""
 }, {
 "identity": {
 "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
 },
 "keyName": "key2",
 "keyVaultUri": "https://testkeyvault.vault.azure.net/",
 "keyVersion": ""
 }}
Location : North Europe
MaximumThroughputUnit : 0
MetricId : 000000000000000:myNamespace
MinimumTlsVersion : 1.2
Name : myNamespace
PrincipalId :
PrivateEndpointConnection :
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
RequireInfrastructureEncryption : False
ResourceGroupName : myResourceGroup
ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/
SkuCapacity : 1
SkuName : Premium
SkuTier : Premium
Status : Active
Tag : {
 }
TenantId :
Type : Microsoft.EventHub/Namespaces
UpdatedAt : 11/17/2022 3:03:50 PM
UserAssignedIdentity : {
 "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": {
 },
 "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": {
 }
 }
ZoneRedundant : True

Creates a new Premium EventHub namespace with UserAssignedIdentity encryption

Example 2: Create a new EventHub namespace with System Assigned Identity enabled

New-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType SystemAssigned

AlternateName :
ClusterArmId :
CreatedAt : 11/17/2022 3:14:09 PM
DisableLocalAuth : False
EnableAutoInflate : False
Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
IdentityType : SystemAssigned
KafkaEnabled : True
KeySource :
KeyVaultProperty :
Location : North Europe
MaximumThroughputUnit : 0
MetricId : 000000000000000:myNamespace
MinimumTlsVersion : 1.2
Name : myNamespace
PrincipalId : 000000000000000000
PrivateEndpointConnection :
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
RequireInfrastructureEncryption :
ResourceGroupName : myResourceGroup
ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/
SkuCapacity : 1
SkuName : Premium
SkuTier : Premium
Status : Active
Tag : {
 }
TenantId : 00000000000
Type : Microsoft.EventHub/Namespaces
UpdatedAt : 11/17/2022 3:21:19 PM
UserAssignedIdentity : {
 }
ZoneRedundant : True

Create an EventHub namespace with SystemAssigned identity.

Example 3: Create a new Standard EventHub namespace with AutoInflate enabled

New-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuCapacity 10 -MaximumThroughputUnit 18 -SkuName Standard -Location southcentralus -Tag @{k1='v1'; k2='v2'} -EnableAutoInflate -DisableLocalAuth

AlternateName :
ClusterArmId :
CreatedAt : 11/17/2022 3:14:09 PM
DisableLocalAuth : True
EnableAutoInflate : True
Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
IdentityType :
KafkaEnabled : True
KeySource :
KeyVaultProperty :
Location : South Central US
MaximumThroughputUnit : 0
MetricId : 000000000000000:myNamespace
MinimumTlsVersion : 1.2
Name : myNamespace
PrincipalId : 000000000000000000
PrivateEndpointConnection :
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
RequireInfrastructureEncryption :
ResourceGroupName : myResourceGroup
ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/
SkuCapacity : 1
SkuName : Standard
SkuTier : Standard
Status : Active
Tag : {
 }
TenantId : 00000000000
Type : Microsoft.EventHub/Namespaces
UpdatedAt : 11/17/2022 3:21:19 PM
UserAssignedIdentity : {
 }
ZoneRedundant : True

Create a standard EventHub namespace myNamespace with Auto Inflate enabled.

Parameters

-AlternateName

Alternate name specified when alias and namespace names are same

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-AsJob

Run the command as a job

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-ClusterArmId

Cluster ARM ID of the Namespace.

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 credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:	PSObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureRMContext, AzureCredential

Parameter sets

-DisableLocalAuth

This property disables SAS authentication for the Event Hubs namespace.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-EnableAutoInflate

Value that indicates whether AutoInflate is enabled for eventhub namespace.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-IdentityType

Type of managed service identity.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-KeyVaultProperty

Properties to configure Encryption

Parameter properties

Type:	IKeyVaultProperties[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-Location

Cluster ARM ID of the Namespace.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-MaximumThroughputUnit

Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)

Parameter properties

Type:	Int64
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-MinimumTlsVersion

The minimum TLS version for the cluster to support, e.g. '1.2'

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-Name

The name of EventHub namespace.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-PublicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-RequireInfrastructureEncryption

Enable Infrastructure Encryption (Double Encryption)

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-SkuCapacity

The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units.

Parameter properties

Type:	Int64
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-SkuName

The minimum TLS version for the cluster to support, e.g. '1.2'

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-SubscriptionId

The ID of the target subscription.

Parameter properties

Type:	String
Default value:	(Get-AzContext).Subscription.Id
Supports wildcards:	False
DontShow:	False

Parameter sets

-Tag

Tag of EventHub Namespace.

Parameter properties

Type:	Hashtable
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

-UserAssignedIdentityId

Properties for User Assigned Identities

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

-ZoneRedundant

Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

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.

Outputs

IEhNamespace

Notes

ALIASES

New-AzEventHubNamespaceV2

Feedback

Was this page helpful?

URL: https://learn.microsoft.com/en-us/powershell/module/az.eventhub/new-azeventhubnamespace?view=azps-16.0.0