az eventhubs namespace

Reference

NamespaceV2.

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	Delete an existing namespace. This operation also removes all associated resources under the namespace.
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	List the available Namespaces within a resource group.
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	Get the description of the specified namespace.
az eventhubs namespace update	Update a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
az eventhubs namespace wait	Place the CLI in a waiting state until a condition is met.

az eventhubs namespace create

Edit

Creates the EventHubs Namespace.

az eventhubs namespace create --name
                              --resource-group
                              [--alternate-name]
                              [--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}]
                              [--public-network {Disabled, Enabled}]
                              [--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

--alternate-name

Alternate name specified when alias and namespace names are same.

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

default value: False

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

--public-network --public-network-access

This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile' access rules.

accepted values: Disabled, Enabled

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs namespace delete

Edit

Delete an existing namespace. This operation also removes all associated resources under the namespace.

az eventhubs namespace delete [--ids]
                              [--name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--resource-group]
                              [--subscription]

Examples

Delete 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 --namespace-name -n

The Namespace name.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs namespace exists

Edit

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.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs namespace list

Edit

List the available Namespaces within a resource group.

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

Required Parameters

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs namespace show

Edit

Get the description of the specified namespace.

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

--name --namespace-name -n

The Namespace name.

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs namespace update

Edit

Update a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

az eventhubs namespace update [--add]
                              [--alternate-name]
                              [--capacity]
                              [--cluster-arm-id]
                              [--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
                              [--enable-auto-inflate {0, 1, f, false, n, no, t, true, y, yes}]
                              [--encryption]
                              [--endpoint-connections]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--identity]
                              [--ids]
                              [--kafka-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                              [--maximum-throughput-units]
                              [--minimum-tls-version {1.0, 1.1, 1.2}]
                              [--name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--public-network-access {Disabled, Enabled, SecuredByPerimeter}]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--sku {Basic, Premium, Standard}]
                              [--subscription]
                              [--tags]
                              [--tier {Basic, Premium, Standard}]
                              [--zone-redundant {0, 1, f, false, n, no, t, true, y, yes}]

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

--alternate-name

Alternate name specified when alias and namespace names are same.

--capacity

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.

--cluster-arm-id

Cluster ARM ID of the Namespace.

--disable-local-auth

This property disables SAS authentication for the Event Hubs namespace.

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--enable-auto-inflate

Value that indicates whether AutoInflate is enabled for eventhub namespace.

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--encryption

Properties of BYOK Encryption description Support shorthand-syntax, json-file and yaml-file. Try ?? to show more.

--endpoint-connections --private-endpoint-connections

List of private endpoint connections. Support shorthand-syntax, json-file and yaml-file. Try ?? to show more.

--force-string

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--identity

Properties of BYOK Identity description Support shorthand-syntax, json-file and yaml-file. Try ?? to show more.

--ids

--kafka-enabled

Value that indicates whether Kafka is enabled for eventhub namespace.

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--maximum-throughput-units

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

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

The Namespace name.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes

--public-network-access

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

accepted values: Disabled, Enabled, SecuredByPerimeter

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

Name of this 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

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try ?? to show more.

--tier

The billing tier of this particular SKU.

accepted values: Basic, Premium, Standard

--zone-redundant

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs namespace wait

Edit

Place the CLI in a waiting state until a condition is met.

az eventhubs namespace wait [--created]
                            [--custom]
                            [--deleted]
                            [--exists]
                            [--ids]
                            [--interval]
                            [--name]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False

--exists

Wait until the resource exists.

default value: False

--ids

--interval

Polling interval in seconds.

default value: 30

--name --namespace-name -n

The Namespace name.

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

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs namespace

Commands

az eventhubs namespace create

Examples

Required Parameters

Optional Parameters

az eventhubs namespace delete

Examples

Optional Parameters

az eventhubs namespace exists

Examples

Required Parameters

az eventhubs namespace list

Examples

Required Parameters

az eventhubs namespace show

Examples

Optional Parameters

az eventhubs namespace update

Examples

Optional Parameters

az eventhubs namespace wait

Optional Parameters

Feedback

Additional resources