az eventhubs cluster
Manage Azure EventHubs Clusters.
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 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 wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
az eventhubs cluster available-region
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Create an instance of an Event Hubs Cluster.
az eventhubs cluster create --cluster-name
--resource-group
[--capacity]
[--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]
The name of the Event Hubs Cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
Resource location. When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
Provisioning state of the Cluster.
Name of this SKU.
A value that indicates whether Scaling is Supported.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Delete an existing Event Hubs Cluster. This operation is idempotent.
az eventhubs cluster delete [--cluster-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
The name of the Event Hubs Cluster.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
List the available Event Hubs Clusters within an ARM resource group.
az eventhubs cluster list [--resource-group]
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Get the resource description of the specified Event Hubs Cluster.
az eventhubs cluster show [--cluster-name]
[--ids]
[--resource-group]
[--subscription]
The name of the Event Hubs Cluster.
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 of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Update an instance of an Event Hubs Cluster.
az eventhubs cluster update [--add]
[--capacity]
[--cluster-name]
[--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]
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>
.
The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
The name of the Event Hubs Cluster.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Do not wait for the long-running operation to finish.
Provisioning state of the Cluster.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name of this SKU.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
A value that indicates whether Scaling is Supported.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Place the CLI in a waiting state until a condition is met.
az eventhubs cluster wait [--cluster-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
The name of the Event Hubs Cluster.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: