Set-AzEventHubNamespace
Updates the specified Event Hubs namespace.
Syntax
Set-AzEventHubNamespace
[-ResourceGroupName] <String>
[-Name] <String>
[-Location] <String>
[[-SkuName] <String>]
[[-SkuCapacity] <Int32>]
[[-State] <NamespaceState>]
[[-Tag] <Hashtable>]
[-EnableKafka]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzEventHubNamespace
[-ResourceGroupName] <String>
[-Name] <String>
[-Location] <String>
[[-SkuName] <String>]
[[-SkuCapacity] <Int32>]
[[-State] <NamespaceState>]
[[-Tag] <Hashtable>]
[-EnableAutoInflate]
[-MaximumThroughputUnits <Int32>]
[-EnableKafka]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzEventHubNamespace cmdlet updates the properties of the specified Event Hubs namespace.
Examples
Example 1
PS C:\> Set-AzEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location "WestUS" -Tag @{Tag1='TagValue1'; Tag2='TagValue2'}
Name : MyNamespaceName
Id : /subscriptions/{subscriptionId}/resourceGroups/Default-EventHub-WestCentralUS/providers/Microsoft.EventHub/namespaces/MyNamespaceName
ResourceGroupName : Default-EventHub-WestCentralUS
Location : West US
Sku : Name : Standard , Capacity : 1 , Tier : Standard
Tags : {Tag2, TagValue2, Tag1, TagValue1}
ProvisioningState : Succeeded
Status : Active
CreatedAt : 5/24/2019 12:47:27 AM
UpdatedAt : 5/24/2019 12:48:14 AM
ServiceBusEndpoint : #########
Enabled : True
KafkaEnabled : True
IsAutoInflateEnabled : True
MaximumThroughputUnits : 10
Updates the Tags for namespace `MyNamespaceName` to Created .
Example 2
PS C:\> Set-AzEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location "WestUS" -State Created -EnableAutoInflate -MaximumThroughputUnits 10
Name : MyNamespaceName
Id : /subscriptions/{subscriptionId}/resourceGroups/Default-EventHub-WestCentralUS/providers/Microsoft.EventHub/namespaces/MyNamespaceName
ResourceGroup : Default-EventHub-WestCentralUS
ResourceGroupName : Default-EventHub-WestCentralUS
Location : West US
Sku : Name : Standard , Capacity : 1 , Tier : Standard
Tags :
ProvisioningState : Succeeded
Status : Active
CreatedAt : 5/24/2019 12:47:27 AM
UpdatedAt : 5/24/2019 12:48:14 AM
ServiceBusEndpoint : #########
Enabled : True
KafkaEnabled : True
IsAutoInflateEnabled : True
MaximumThroughputUnits : 10
Updates the state of namespace `MyNamespaceName` with AutoInflate = enabled and MaximumThroughputUnits = 10
Parameters
-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: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EnableAutoInflate
Indicates whether AutoInflate is enabled
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EnableKafka
enabling or disabling Kafka for namespace
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Location
EventHub Namespace Location.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-MaximumThroughputUnits
Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units.
Type: | Nullable<T>[Int32] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
EventHub Namespace Name.
Type: | String |
Aliases: | NamespaceName |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
Resource Group Name.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SkuCapacity
The eventhub throughput units.
Type: | Nullable<T>[Int32] |
Position: | 4 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SkuName
Namespace Sku Name.
Type: | String |
Accepted values: | Basic, Standard, Premium |
Position: | 3 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-State
Disable/Enable Namespace.
Type: | Nullable<T>[NamespaceState] |
Accepted values: | Unknown, Active, Disabled |
Position: | 5 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Tag
Hashtables which represents resource Tag.
Type: | Hashtable |
Position: | 6 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
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 |
Inputs
Nullable<T>[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
Nullable<T>[[Microsoft.Azure.Commands.EventHub.Models.NamespaceState, Microsoft.Azure.PowerShell.Cmdlets.EventHub, Version=1.3.0.0, Culture=neutral, PublicKeyToken=null]]