az eventhubs cluster

Manage Azure EventHubs Clusters.

Commands

az eventhubs cluster available-region

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

az eventhubs cluster create

Create EventHubs Cluster.

az eventhubs cluster delete

Delete an existing Event Hubs Cluster.

az eventhubs cluster list

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

az eventhubs cluster namespace

Manage Azure EventHubs Cluster for namespace.

az eventhubs cluster namespace list

List of Namespaces within given Cluster.

az eventhubs cluster show

Get the resource description of the specified Event Hubs Cluster.

az eventhubs cluster update

Update tags of EventHubs Cluster.

az eventhubs cluster wait

Place the CLI in a waiting state until a condition of the Cluster operation is completed.

az eventhubs cluster available-region

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

az eventhubs cluster available-region [--subscription]

Examples

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

az eventhubs cluster available-region

Optional Parameters

--subscription

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

az eventhubs cluster create

Create EventHubs Cluster.

az eventhubs cluster create --name
                            --resource-group
                            [--capacity]
                            [--location]
                            [--subscription]
                            [--tags]

Examples

Create a new cluster.

az eventhubs cluster create --resource-group myresourcegroup --name mycluster --location mylocation --capacity 1 --tags tag=value

Required Parameters

--name -n

Name of Cluster.

--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, allowed value : 1.

--location -l

Location of the Cluster, for locations of available pre-provision clusters, please check az evetnhubs.

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

az eventhubs cluster delete

Delete an existing Event Hubs Cluster.

az eventhubs cluster delete --name
                            --resource-group
                            [--no-wait]
                            [--subscription]
                            [--yes]

Examples

Delete an existing Event Hubs Cluster.

az eventhubs cluster delete --resource-group myresourcegroup --name mycluster

Required Parameters

--name -n

Name of Cluster.

--resource-group -g

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

Optional Parameters

--no-wait

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

--subscription

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

--yes -y

Do not prompt for confirmation.

az eventhubs cluster list

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

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

Examples

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

az eventhubs cluster list --resource-group myresourcegroup

Required Parameters

--resource-group -g

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

Optional Parameters

--query-examples

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

--subscription

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

az eventhubs cluster show

Get the resource description of the specified Event Hubs Cluster.

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

Examples

Get the resource description of the specified Event Hubs Cluster.

az eventhubs cluster show --resource-group myresourcegroup --name mycluster

Required Parameters

--name -n

Name of Cluster.

--resource-group -g

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

Optional Parameters

--query-examples

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

--subscription

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

az eventhubs cluster update

Update tags of EventHubs Cluster.

az eventhubs cluster update --name
                            --resource-group
                            [--add]
                            [--force-string]
                            [--remove]
                            [--set]
                            [--subscription]
                            [--tags]

Examples

Update tags of a existing cluster.

az eventhubs cluster update --resource-group myresourcegroup --name mycluster --tags tag=value

Required Parameters

--name -n

Name of Cluster.

--resource-group -g

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

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

--force-string

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

--remove

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

--set

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

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

az eventhubs cluster wait

Place the CLI in a waiting state until a condition of the Cluster operation is completed.

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

Required Parameters

--name -n

Name of Cluster.

--resource-group -g

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

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

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