Share via

az eventhubs namespace

Eventhub namespace.

Commands

Name Description Type Status
az eventhubs namespace application-group

Manages Application Groups for premium eventhubs namespace.

 Core GA
az eventhubs namespace application-group create

Creates an application group for an EventHub namespace.

 Core GA
az eventhubs namespace application-group delete

Delete an ApplicationGroup for a Namespace.

 Core GA
az eventhubs namespace application-group list

List a list of application groups for a Namespace.

 Core GA
az eventhubs namespace application-group policy

Append or Remove application group policies.

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

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

 Core GA
az eventhubs namespace application-group show

Get an ApplicationGroup for a Namespace.

 Core GA
az eventhubs namespace application-group update

Update an ApplicationGroup for a Namespace.

 Core GA
az eventhubs namespace authorization-rule

Eventhub namespace authorization-rule.

 Core GA
az eventhubs namespace authorization-rule create

Create an AuthorizationRule for a Namespace.

 Core GA
az eventhubs namespace authorization-rule delete

Delete an AuthorizationRule for a Namespace.

 Core GA
az eventhubs namespace authorization-rule keys

Authorization-rule keys.

 Core GA
az eventhubs namespace authorization-rule keys list

Gets the primary and secondary connection strings for the Namespace.

 Core GA
az eventhubs namespace authorization-rule keys renew

Regenerates the primary or secondary connection strings for the specified Namespace.

 Core GA
az eventhubs namespace authorization-rule list

List a list of authorization rules for a Namespace.

 Core GA
az eventhubs namespace authorization-rule show

Get an AuthorizationRule for a Namespace by rule name.

 Core GA
az eventhubs namespace authorization-rule update

Update an AuthorizationRule for a Namespace.

 Core GA
az eventhubs namespace create

Creates the EventHubs Namespace.

 Core GA
az eventhubs namespace delete

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

 Core GA
az eventhubs namespace encryption

Manage eventhubs namespace encryption properties.

 Core GA
az eventhubs namespace encryption add

Add Encryption properties to a namespace.

 Core GA
az eventhubs namespace encryption remove

Remove one or more Encryption properties from a namespace.

 Core GA
az eventhubs namespace exists

Check the give Namespace name availability.

 Core GA
az eventhubs namespace failover

GeoDR Failover.

 Core GA
az eventhubs namespace identity

Manage eventhubs namespace identity.

 Core GA
az eventhubs namespace identity assign

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

 Core GA
az eventhubs namespace identity remove

Remove System or User or System,User assigned identities from a namespace.

 Core GA
az eventhubs namespace list

List all the available Namespaces within a subscription, irrespective of the resource groups.

 Core GA
az eventhubs namespace network-rule-set

Manage Azure EventHubs networkruleset for namespace.

 Core GA
az eventhubs namespace network-rule-set create

Create NetworkRuleSet for a Namespace.

 Core GA
az eventhubs namespace network-rule-set ip-rule

Manage Azure eventhubs ip-rules in networkruleSet for namespace.

 Core GA
az eventhubs namespace network-rule-set ip-rule add

Add a IP-Rule for network rule of namespace.

 Core GA
az eventhubs namespace network-rule-set ip-rule remove

Remove Ip-Rule from network rule of namespace.

 Core GA
az eventhubs namespace network-rule-set list

List NetworkRuleSet for a Namespace.

 Core GA
az eventhubs namespace network-rule-set show

Get NetworkRuleSet for a Namespace.

 Core GA
az eventhubs namespace network-rule-set update

Update NetworkRuleSet for a Namespace.

 Core GA
az eventhubs namespace network-rule-set virtual-network-rule

Manage Azure eventhubs subnet-rule in networkruleSet for namespace.

 Core GA
az eventhubs namespace network-rule-set virtual-network-rule add

Add a Virtual-Network-Rule for network rule of namespace.

 Core GA
az eventhubs namespace network-rule-set virtual-network-rule remove

Remove network rule for a namespace.

 Core GA
az eventhubs namespace nsp-configuration

Manage Network Security Perimeter Configuration.

 Core GA
az eventhubs namespace nsp-configuration list

List of current NetworkSecurityPerimeterConfiguration for Namespace.

 Core GA
az eventhubs namespace nsp-configuration show

Get a NetworkSecurityPerimeterConfigurations resourceAssociationName.

 Core GA
az eventhubs namespace private-endpoint-connection

Manage eventhubs namespace private endpoint connection.

 Core GA
az eventhubs namespace private-endpoint-connection approve

Approve a private endpoint connection request for eventhubs namesapce.

 Core GA
az eventhubs namespace private-endpoint-connection create

Create PrivateEndpointConnections of service namespace.

 Core GA
az eventhubs namespace private-endpoint-connection delete

Delete a private endpoint connection request for eventhubs namespace.

 Core GA
az eventhubs namespace private-endpoint-connection list

List the available PrivateEndpointConnections within a namespace.

 Core GA
az eventhubs namespace private-endpoint-connection reject

Reject a private endpoint connection request for eventhubs namespace.

 Core GA
az eventhubs namespace private-endpoint-connection show

Get a description for the specified Private Endpoint Connection name.

 Core GA
az eventhubs namespace private-endpoint-connection update

Update PrivateEndpointConnections of service namespace.

 Core GA
az eventhubs namespace private-endpoint-connection wait

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

 Core GA
az eventhubs namespace private-link-resource

Manage eventhubs namespace private link resources .

 Core GA
az eventhubs namespace private-link-resource show

List lists of resources that supports Privatelinks.

 Core GA
az eventhubs namespace replica

Manage eventhubs namespace replicas.

 Core GA
az eventhubs namespace replica add

Add one or more Replica properties to a namespace.

 Core GA
az eventhubs namespace replica remove

Remove one or more Replica properties to a namespace.

 Core GA
az eventhubs namespace schema-registry

Manages eventhubs namespace schema registry.

 Core GA
az eventhubs namespace schema-registry create

Create an EventHub schema group.

 Core GA
az eventhubs namespace schema-registry delete

Delete an EventHub schema group.

 Core GA
az eventhubs namespace schema-registry list

List all the Schema Groups in a Namespace.

 Core GA
az eventhubs namespace schema-registry show

Get the details of an EventHub schema group.

 Core GA
az eventhubs namespace schema-registry update

Update an EventHub schema group.

 Core GA
az eventhubs namespace show

Get the description of the specified namespace.

 Core GA
az eventhubs namespace update

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

 Core GA
az eventhubs namespace wait

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

 Core GA

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]
                              [--geo-data-replication-config --replica-config]
                              [--infra-encryption {false, true}]
                              [--location]
                              [--max-lag --max-replication-lag-duration-in-seconds]
                              [--maximum-throughput-units]
                              [--mi-system-assigned {false, true}]
                              [--mi-user-assigned]
                              [--min-tls --minimum-tls-version {1.0, 1.1, 1.2}]
                              [--public-network --public-network-access {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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Accepted values: false, true
--enable-auto-inflate

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

Property Value
Accepted values: false, true
--enable-kafka

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

Property Value
Accepted values: false, true
--encryption-config

List of KeyVaultProperties objects.

--geo-data-replication-config --replica-config

A list of regions where replicas of the namespace are maintained Object.

--infra-encryption

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

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

--max-lag --max-replication-lag-duration-in-seconds

The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas.

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

Property Value
Parameter group: Managed Identity Arguments
Default value: False
Accepted values: false, true
--mi-user-assigned

List of User Assigned Identity ids.

Property Value
Parameter group: Managed Identity Arguments
--min-tls --minimum-tls-version

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

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

Property Value
Accepted values: Disabled, Enabled
--sku

Namespace SKU.

Property Value
Default value: Standard
Accepted values: Basic, Premium, 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.

Property Value
Accepted values: false, true
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--name --namespace-name -n

The Namespace name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az eventhubs namespace exists

Edit

Check the give Namespace name availability.

az eventhubs namespace exists --name

Required Parameters

--name

Name to check the namespace name availability.

Property Value
Parameter group: Parameters Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az eventhubs namespace failover

Edit

GeoDR Failover.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--force

If Force is false then graceful failover is attempted after ensuring no data loss. If Force flag is set to true, Forced failover is attempted with possible data loss.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

The Namespace name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--primary-location

Query parameter for the new primary location after failover.

Property Value
Parameter group: Properties Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az eventhubs namespace list

Edit

List all the available Namespaces within a subscription, irrespective of the resource groups.

az eventhubs namespace list [--max-items]
                            [--next-token]
                            [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az eventhubs namespace show

Edit

Get the description of the specified namespace.

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

Examples

shows the Namespace details.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--name --namespace-name -n

The Namespace name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

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 --private-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}]
                              [--locations]
                              [--max-lag --max-replication-lag-duration-in-seconds]
                              [--maximum-throughput-units]
                              [--minimum-tls-version {1.0, 1.1, 1.2}]
                              [--name --namespace-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Generic Update Arguments
--alternate-name

Alternate name specified when alias and namespace names are same.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Sku Arguments
--cluster-arm-id

Cluster ARM ID of the Namespace.

Property Value
Parameter group: Properties Arguments
--disable-local-auth

This property disables SAS authentication for the Event Hubs namespace.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--endpoint-connections --private-endpoint-connections

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

Property Value
Parameter group: Properties Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
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.

Property Value
Parameter group: Parameters Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--kafka-enabled

Value that indicates whether Kafka is enabled for eventhub namespace.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--locations

A list of regions where replicas of the namespace are maintained. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: GeoDataReplication Arguments
--max-lag --max-replication-lag-duration-in-seconds

The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed.

Property Value
Parameter group: GeoDataReplication Arguments
--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).

Property Value
Parameter group: Properties Arguments
--minimum-tls-version

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

Property Value
Parameter group: Properties Arguments
Accepted values: 1.0, 1.1, 1.2
--name --namespace-name -n

The Namespace name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled, SecuredByPerimeter
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--sku

Name of this SKU.

Property Value
Parameter group: Sku Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--tags

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

Property Value
Parameter group: Parameters Arguments
--tier

The billing tier of this particular SKU.

Property Value
Parameter group: Sku Arguments
Accepted values: Basic, Premium, Standard
--zone-redundant

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

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

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 --namespace-name]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --namespace-name -n

The Namespace name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False