az eventhubs namespace

Manage Azure EventHubs namespace and Authorizationrule.

Commands

az eventhubs namespace application-group

Manages Application Groups for premium eventhubs namespace.

az eventhubs namespace application-group create

Creates an application group for an EventHub namespace.

az eventhubs namespace application-group delete

Deletes an ApplicationGroup for a Namespace.

az eventhubs namespace application-group list

Lists all application groups in an EventHub namespace.

az eventhubs namespace application-group policy

Append or Remove application group policies.

az eventhubs namespace application-group policy add

Appends an application group policy to the existing policy. This cmdlet can be used to append one or more throttling policies.

az eventhubs namespace application-group policy remove

Removes an application group policy from the existing policies. This cmdlet can be used to remove one or more throttling policies.

az eventhubs namespace application-group show

Gets an application group in an EventHub namespace.

az eventhubs namespace application-group update

Updates an application group in an EventHub namespace.

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 encryption

Manage eventhubs namespace encryption properties.

az eventhubs namespace encryption add

Add Encryption properties to a namespace.

az eventhubs namespace encryption remove

Remove one or more Encryption properties from a namespace.

az eventhubs namespace exists

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

az eventhubs namespace identity

Manage eventhubs namespace identity.

az eventhubs namespace identity assign

Assign System or User or System,User assigned identities to a namespace.

az eventhubs namespace identity remove

Remove System or User or System,User assigned identities from a 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 network-rule update

Updates network rule properties of the given Namespace.

az eventhubs namespace private-endpoint-connection

Manage eventhubs namespace private endpoint connection.

az eventhubs namespace private-endpoint-connection approve

Approve a private endpoint connection request for eventhubs namesapce.

az eventhubs namespace private-endpoint-connection delete

Delete a private endpoint connection request for eventhubs namespace.

az eventhubs namespace private-endpoint-connection list

Gets the available PrivateEndpointConnections within a namespace.

az eventhubs namespace private-endpoint-connection reject

Reject a private endpoint connection request for eventhubs namespace.

az eventhubs namespace private-endpoint-connection show

Show details of a private endpoint connection request for eventhubs namespace.

az eventhubs namespace private-link-resource

Manage eventhubs namespace private link resources.

az eventhubs namespace private-link-resource show

Get the private link resources that need to be created for a eventhubs namespace.

az eventhubs namespace schema-registry

Manages eventhubs namespace schema registry.

az eventhubs namespace schema-registry create

Creates a schema group for an EventHub namespace.

az eventhubs namespace schema-registry delete

Deletes a schema group from a namespace.

az eventhubs namespace schema-registry list

Lists all schema groups of the EventHub Namespace.

az eventhubs namespace schema-registry show

Get a specific schema group from an EventHub 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
                              [--capacity]
                              [--cluster-arm-id]
                              [--disable-local-auth {false, true}]
                              [--enable-auto-inflate {false, true}]
                              [--enable-kafka {false, true}]
                              [--encryption-config]
                              [--infra-encryption {false, true}]
                              [--location]
                              [--maximum-throughput-units]
                              [--mi-system-assigned {false, true}]
                              [--mi-user-assigned]
                              [--min-tls {1.0, 1.1, 1.2}]
                              [--sku {Basic, Premium, Standard}]
                              [--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

Create a new namespace with Identity and Encryption enabled.

az eventhubs namespace create --resource-group myresourcegroup --name mynamespace --location westus --sku Premium --mi-user-assigned /subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName

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

--capacity

Capacity for Sku.

--cluster-arm-id

Cluster ARM ID of the Namespace.

--disable-local-auth

A boolean value that indicates whether SAS authentication is enabled/disabled for the Event Hubs.

accepted values: false, true
--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
--encryption-config

List of KeyVaultProperties objects.

--infra-encryption

A boolean value that indicates whether Infrastructure Encryption (Double Encryption) is enabled/disabled.

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).

--mi-system-assigned

Enable System Assigned Identity.

accepted values: false, true
--mi-user-assigned

List of User Assigned Identity ids.

--min-tls --minimum-tls-version

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

accepted values: 1.0, 1.1, 1.2
--sku

Namespace SKU.

accepted values: Basic, Premium, Standard
default value: Standard
--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

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 -n

Namespace name. Name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number.

az eventhubs namespace list

Lists the EventHubs Namespaces.

az eventhubs namespace list [--resource-group]

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

--resource-group -g

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

az eventhubs namespace show

Shows the Event Hubs Namespace Details.

az eventhubs namespace show [--ids]
                            [--name]
                            [--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.

--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]
                              [--capacity]
                              [--disable-local-auth {false, true}]
                              [--enable-auto-inflate {false, true}]
                              [--enable-kafka {false, true}]
                              [--force-string]
                              [--ids]
                              [--infra-encryption {false, true}]
                              [--maximum-throughput-units]
                              [--min-tls {1.0, 1.1, 1.2}]
                              [--name]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--sku {Basic, Premium, 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>.

default value: []
--capacity

Capacity for Sku.

--disable-local-auth

A boolean value that indicates whether SAS authentication is enabled/disabled for the Event Hubs.

accepted values: false, true
--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
--force-string

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

default value: False
--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.

--infra-encryption

A boolean value that indicates whether Infrastructure Encryption (Double Encryption) is enabled/disabled.

accepted values: false, true
--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).

--min-tls --minimum-tls-version

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

accepted values: 1.0, 1.1, 1.2
--name -n

Name of Namespace.

--remove

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

default value: []
--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=.

default value: []
--sku

Namespace SKU.

accepted values: Basic, Premium, 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.