az eventhubs cluster

Manage Azure EventHubs Clusters.

Commands

Name Description Type Status
az eventhubs cluster available-region

List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.

 Core GA
az eventhubs cluster create

Create an instance of an Event Hubs Cluster.

 Core GA
az eventhubs cluster delete

Delete an existing Event Hubs Cluster. This operation is idempotent.

 Core GA
az eventhubs cluster list

List the available Event Hubs Clusters within an ARM resource group.

 Core GA
az eventhubs cluster namespace

List of Namespaces within given Cluster.

 Core GA
az eventhubs cluster namespace list

List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.

 Core GA
az eventhubs cluster quota-configuration

Manage quota and settings configuration of an Event Hubs Dedicated Cluster.

 Core GA
az eventhubs cluster quota-configuration show

Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.

 Core GA
az eventhubs cluster quota-configuration update

Update all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.

 Core GA
az eventhubs cluster show

Get the resource description of the specified Event Hubs Cluster.

 Core GA
az eventhubs cluster update

Update an instance of an Event Hubs Cluster.

 Core GA
az eventhubs cluster upgrade-preference

Manage upgrade preferences of an Event Hubs Dedicated Cluster.

 Core GA
az eventhubs cluster upgrade-preference create

Create the upgrade preferences for an Event Hubs Dedicated cluster.

 Core GA
az eventhubs cluster upgrade-preference show

Get the upgrade preferences for an Event Hubs Dedicated cluster.

 Core GA
az eventhubs cluster upgrade-preference update

Update the upgrade preferences for an Event Hubs Dedicated cluster.

 Core GA
az eventhubs cluster upgrade-preference upgrade-now

Starts an immediate eight-hour upgrade override when an upgrade is pending.

 Core GA
az eventhubs cluster wait

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

 Core GA

az eventhubs cluster available-region

Edit

List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.

az eventhubs cluster available-region [--acquire-policy-token]
                                      [--change-reference]

Examples

ListAvailableClusters

az eventhubs cluster available-region

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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 cluster create

Edit

Create an instance of an Event Hubs Cluster.

az eventhubs cluster create --cluster-name --name
                            --resource-group
                            [--acquire-policy-token]
                            [--capacity]
                            [--change-reference]
                            [--confidential-compute-mode --mode {Disabled, Enabled}]
                            [--location]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--provisioning-state]
                            [--sku {Dedicated}]
                            [--supports-scaling {0, 1, f, false, n, no, t, true, y, yes}]
                            [--tags]
                            [--zone-redundant {0, 1, f, false, n, no, t, true, y, yes}]

Examples

ClusterPut

az eventhubs cluster create --resource-group myResourceGroup --cluster-name testCluster --location South Central US --sku Dedicated --capacity 1 --tags "{tag1:value1,tag2:value2}"

Required Parameters

--cluster-name --name -n

The name of the Event Hubs Cluster.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--capacity

The quantity of Event Hubs Cluster Capacity Units contained in this cluster.

Property Value
Parameter group: Sku Arguments
Default value: 1
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--confidential-compute-mode --mode

Setting to Enable or Disable Confidential Compute.

Property Value
Parameter group: ConfidentialCompute Arguments
Accepted values: Disabled, Enabled
--location -l

Resource location.

Property Value
Parameter group: Parameters 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
--provisioning-state

Provisioning state of the Cluster.

Property Value
Parameter group: Properties Arguments
--sku

Name of this SKU.

Property Value
Parameter group: Sku Arguments
Default value: Dedicated
Accepted values: Dedicated
--supports-scaling

A value that indicates whether Scaling is Supported.

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

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

Property Value
Parameter group: Parameters Arguments
--zone-redundant

A value that indicates whether the cluster is zone redundant.

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.

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

Edit

Delete an existing Event Hubs Cluster. This operation is idempotent.

az eventhubs cluster delete [--acquire-policy-token]
                            [--change-reference]
                            [--cluster-name --name]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]
                            [--yes]

Examples

ClusterDelete

az eventhubs cluster delete --resource-group myResourceGroup --cluster-name testCluster

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name --name -n

The name of the Event Hubs Cluster.

Property Value
Parameter group: Resource Id 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
--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
--yes -y

Do not prompt for confirmation.

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

az eventhubs cluster list

Edit

List the available Event Hubs Clusters within an ARM resource group.

az eventhubs cluster list [--max-items]
                          [--next-token]
                          [--resource-group]

Examples

ClustersListBySubscription

az eventhubs cluster list

ClustersListByResourceGroup

az eventhubs cluster list --resource-group myResourceGroup

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

Edit

Get the resource description of the specified Event Hubs Cluster.

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

Examples

ClusterGet

az eventhubs cluster show --resource-group myResourceGroup --cluster-name testCluster

Optional Parameters

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

--cluster-name --name -n

The name of the Event Hubs Cluster.

Property Value
Parameter group: Resource Id 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
--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 cluster update

Edit

Update an instance of an Event Hubs Cluster.

az eventhubs cluster update [--acquire-policy-token]
                            [--add]
                            [--capacity]
                            [--change-reference]
                            [--cluster-name --name]
                            [--confidential-compute-mode --mode {Disabled, Enabled}]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--provisioning-state]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--sku {Dedicated}]
                            [--subscription]
                            [--supports-scaling {0, 1, f, false, n, no, t, true, y, yes}]
                            [--tags]
                            [--zone-redundant {0, 1, f, false, n, no, t, true, y, yes}]

Examples

ClusterPut

az eventhubs cluster update --resource-group myResourceGroup --cluster-name testCluster

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
--capacity

The quantity of Event Hubs Cluster Capacity Units contained in this cluster.

Property Value
Parameter group: Sku Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name --name -n

The name of the Event Hubs Cluster.

Property Value
Parameter group: Resource Id Arguments
--confidential-compute-mode --mode

Setting to Enable or Disable Confidential Compute.

Property Value
Parameter group: ConfidentialCompute Arguments
Accepted values: Disabled, Enabled
--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
--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
--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
--provisioning-state

Provisioning state of the Cluster.

Property Value
Parameter group: Properties Arguments
--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: Dedicated
--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
--supports-scaling

A value that indicates whether Scaling is Supported.

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

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

Property Value
Parameter group: Parameters Arguments
--zone-redundant

A value that indicates whether the cluster is zone redundant.

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

Edit

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

az eventhubs cluster wait [--acquire-policy-token]
                          [--change-reference]
                          [--cluster-name --name]
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--ids]
                          [--interval]
                          [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name --name -n

The name of the Event Hubs Cluster.

Property Value
Parameter group: Resource Id Arguments
--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
--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