az eventhubs eventhub consumer-group
Manage Azure Event Hubs consumergroup.
Commands
az eventhubs eventhub consumer-group create |
Creates the EventHub ConsumerGroup. |
az eventhubs eventhub consumer-group delete |
Deletes the ConsumerGroup. |
az eventhubs eventhub consumer-group list |
List the ConsumerGroup by Eventhub. |
az eventhubs eventhub consumer-group show |
Shows the ConsumerGroup Details. |
az eventhubs eventhub consumer-group update |
Updates the EventHub ConsumerGroup. |
az eventhubs eventhub consumer-group create
Creates the EventHub ConsumerGroup.
az eventhubs eventhub consumer-group create --eventhub-name
--name
--namespace-name
--resource-group
[--user-metadata]
Examples
Create EventHub ConsumerGroup.
az eventhubs eventhub consumer-group create --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myconsumergroup
Required Parameters
Name of EventHub.
Name of ConsumerGroup.
Name of Namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Usermetadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.
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.
az eventhubs eventhub consumer-group delete
Deletes the ConsumerGroup.
az eventhubs eventhub consumer-group delete [--eventhub-name]
[--ids]
[--name]
[--namespace-name]
[--resource-group]
[--subscription]
Examples
Deletes the ConsumerGroup
az eventhubs eventhub consumer-group delete --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myconsumergroup
Optional Parameters
Name of EventHub.
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 ConsumerGroup.
Name of Namespace.
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
.
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.
az eventhubs eventhub consumer-group list
List the ConsumerGroup by Eventhub.
az eventhubs eventhub consumer-group list --eventhub-name
--namespace-name
--resource-group
[--skip]
[--top]
Examples
List the ConsumerGroup by Eventhub.
az eventhubs eventhub consumer-group list --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub
Required Parameters
Name of EventHub.
Name of Namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. Default value is None.
May be used to limit the number of results to the most recent N usageDetails. Default value is None.
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.
az eventhubs eventhub consumer-group show
Shows the ConsumerGroup Details.
az eventhubs eventhub consumer-group show [--eventhub-name]
[--ids]
[--name]
[--namespace-name]
[--resource-group]
[--subscription]
Examples
Shows the ConsumerGroup details.
az eventhubs eventhub consumer-group show --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myconsumergroup
Optional Parameters
Name of EventHub.
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 ConsumerGroup.
Name of Namespace.
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
.
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.
az eventhubs eventhub consumer-group update
Updates the EventHub ConsumerGroup.
az eventhubs eventhub consumer-group update [--add]
[--eventhub-name]
[--force-string]
[--ids]
[--name]
[--namespace-name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--user-metadata]
Examples
Updates a ConsumerGroup.
az eventhubs eventhub consumer-group update --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub --name myconsumergroup --user-metadata MyUserMetadata
Optional Parameters
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>.
Name of EventHub.
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.
Name of ConsumerGroup.
Name of Namespace.
Remove a property or an element from a list. Example: --remove property.list 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=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Usermetadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.
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.
Feedback
Submit and view feedback for