az eventhubs namespace

Manage Azure EventHubs namespace and Authorizationrule.

Commands

az eventhubs namespace authorization-rule

Manage Azure EventHubs Authorizationrule for Namespace.

az eventhubs namespace authorization-rule create

Creates Authorizationrule for the given Namespace.

az eventhubs namespace authorization-rule delete

Deletes the Authorizationrule of the namespace.

az eventhubs namespace authorization-rule keys

Manage Azure EventHubs Authorizationrule connection strings for Namespace.

az eventhubs namespace authorization-rule keys list

Shows the connection strings for namespace.

az eventhubs namespace authorization-rule keys renew

Regenerate the connection strings of Authorizationrule for the namespace.

az eventhubs namespace authorization-rule list

Shows the list of Authorizationrule by Namespace.

az eventhubs namespace authorization-rule show

Shows the details of Authorizationrule.

az eventhubs namespace authorization-rule update

Updates Authorizationrule for the given Namespace.

az eventhubs namespace create

Creates the EventHubs Namespace.

az eventhubs namespace delete

Deletes the Namespaces.

az eventhubs namespace exists

Check for the availability of the given name for the Namespace.

az eventhubs namespace list

Lists the EventHubs Namespaces.

az eventhubs namespace network-rule

Manage Azure EventHubs networkruleset for namespace.

az eventhubs namespace network-rule add

Add a network rule for a namespace.

az eventhubs namespace network-rule list

Show properties of Network rule of the given Namespace.

az eventhubs namespace network-rule remove

Remove network rule for a namespace.

az eventhubs namespace show

Shows the Event Hubs Namespace Details.

az eventhubs namespace update

Updates the EventHubs Namespace.

az eventhubs namespace create

Creates the EventHubs Namespace.

az eventhubs namespace create --name
                              --resource-group
                              [--assign-identity {false, true}]
                              [--capacity]
                              [--cluster-arm-id]
                              [--default-action {Allow, Deny}]
                              [--enable-auto-inflate {false, true}]
                              [--enable-kafka {false, true}]
                              [--enable-trusted-service-access {false, true}]
                              [--location]
                              [--maximum-throughput-units]
                              [--sku {Basic, Standard}]
                              [--subscription]
                              [--tags]
                              [--zone-redundant {false, true}]

Examples

Creates a new namespace.

az eventhubs namespace create --resource-group myresourcegroup --name mynamespace --location westus --tags tag1=value1 tag2=value2 --sku Standard --enable-auto-inflate --maximum-throughput-units 20

Required Parameters

--name -n

Name of Namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--assign-identity

A boolean value that indicates whether Managed Identity is enabled.

accepted values: false, true
--capacity

Capacity for Sku.

--cluster-arm-id

Luster ARM ID of the Namespace.

--default-action

Default Action for Network Rule Set.

accepted values: Allow, Deny
--enable-auto-inflate

A boolean value that indicates whether AutoInflate is enabled for eventhub namespace.

accepted values: false, true
--enable-kafka

A boolean value that indicates whether Kafka is enabled for eventhub namespace.

accepted values: false, true
--enable-trusted-service-access -t

A boolean value that indicates whether Trusted Service Access is enabled for Network Rule Set.

accepted values: false, true
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--maximum-throughput-units

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

--sku

Namespace SKU.

accepted values: Basic, Standard
default value: Standard
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--zone-redundant

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

accepted values: false, true

az eventhubs namespace delete

Deletes the Namespaces.

az eventhubs namespace delete [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

Examples

Deletes the Namespace

az eventhubs namespace delete --resource-group myresourcegroup --name mynamespace

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of Namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az eventhubs namespace exists

Check for the availability of the given name for the Namespace.

az eventhubs namespace exists --name
                              [--subscription]

Examples

Create a new topic.

az eventhubs namespace exists --name mynamespace

check for the availability of the given name for the Namespace (autogenerated)

az eventhubs namespace exists --name mynamespace --subscription MySubscription

Required Parameters

--name

Name to check the namespace name availability.

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az eventhubs namespace list

Lists the EventHubs Namespaces.

az eventhubs namespace list [--query-examples]
                            [--resource-group]
                            [--subscription]

Examples

List the Event Hubs Namespaces by resource group.

az eventhubs namespace list --resource-group myresourcegroup

Get the Namespaces by Subscription.

az eventhubs namespace list

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az eventhubs namespace show

Shows the Event Hubs Namespace Details.

az eventhubs namespace show [--ids]
                            [--name]
                            [--query-examples]
                            [--resource-group]
                            [--subscription]

Examples

shows the Namespace details.

az eventhubs namespace show --resource-group myresourcegroup --name mynamespace

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of Namespace.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az eventhubs namespace update

Updates the EventHubs Namespace.

az eventhubs namespace update [--add]
                              [--assign-identity {false, true}]
                              [--capacity]
                              [--default-action {Allow, Deny}]
                              [--enable-auto-inflate {false, true}]
                              [--enable-kafka {false, true}]
                              [--enable-trusted-service-access {false, true}]
                              [--force-string]
                              [--ids]
                              [--key-name]
                              [--key-source {Microsoft.KeyVault}]
                              [--key-vault-uri]
                              [--key-version]
                              [--maximum-throughput-units]
                              [--name]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--sku {Basic, Standard}]
                              [--subscription]
                              [--tags]

Examples

Update a new namespace.

az eventhubs namespace update --resource-group myresourcegroup --name mynamespace --tags tag=value --enable-auto-inflate True

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--assign-identity

A boolean value that indicates whether Managed Identity is enabled.

accepted values: false, true
--capacity

Capacity for Sku.

--default-action

Default Action for Network Rule Set.

accepted values: Allow, Deny
--enable-auto-inflate

A boolean value that indicates whether AutoInflate is enabled for eventhub namespace.

accepted values: false, true
--enable-kafka

A boolean value that indicates whether Kafka is enabled for eventhub namespace.

accepted values: false, true
--enable-trusted-service-access -t

A boolean value that indicates whether Trusted Service Access is enabled for Network Rule Set.

accepted values: false, true
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--key-name

The name of the KeyVault key.

--key-source

Encryption key source.

accepted values: Microsoft.KeyVault
--key-vault-uri

The Uri of the KeyVault.

--key-version

The version of the KeyVault key to use.

--maximum-throughput-units

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

--name -n

Name of Namespace.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--sku

Namespace SKU.

accepted values: Basic, Standard
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.