az eventhubs eventhub consumer-group
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage Azure Event Hubs consumergroup.
Commands
Name | Description | Type | Status |
---|---|---|---|
az eventhubs eventhub consumer-group create |
Create an Event Hubs consumer group as a nested resource within a Namespace. |
Core | Preview |
az eventhubs eventhub consumer-group delete |
Delete a consumer group from the specified Event Hub and resource group. |
Core | Preview |
az eventhubs eventhub consumer-group list |
List all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace. |
Core | Preview |
az eventhubs eventhub consumer-group show |
Get a description for the specified consumer group. |
Core | Preview |
az eventhubs eventhub consumer-group update |
Update an Event Hubs consumer group as a nested resource within a Namespace. |
Core | Preview |
az eventhubs eventhub consumer-group create
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create an Event Hubs consumer group as a nested resource within a Namespace.
az eventhubs eventhub consumer-group create --consumer-group-name
--eventhub-name
--namespace-name
--resource-group
[--user-metadata]
Required Parameters
The consumer group name.
The Event Hub name.
The Namespace name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
User Metadata 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.
Global Parameters
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Increase logging verbosity to show all debug logs.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show this help message and exit.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Only show errors, suppressing warnings.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Output format.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
JMESPath query string. See http://jmespath.org/ for more information and examples.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Increase logging verbosity. Use --debug for full debug logs.
az eventhubs eventhub consumer-group delete
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete a consumer group from the specified Event Hub and resource group.
az eventhubs eventhub consumer-group delete [--consumer-group-name]
[--eventhub-name]
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]
Optional Parameters
The consumer group name.
The Event Hub name.
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.
The Namespace name.
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
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Increase logging verbosity to show all debug logs.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show this help message and exit.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Only show errors, suppressing warnings.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Output format.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
JMESPath query string. See http://jmespath.org/ for more information and examples.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Increase logging verbosity. Use --debug for full debug logs.
az eventhubs eventhub consumer-group list
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.
az eventhubs eventhub consumer-group list --eventhub-name
--namespace-name
--resource-group
[--max-items]
[--next-token]
[--skip]
[--top]
Required Parameters
The Event Hub name.
The Namespace name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
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.
May be used to limit the number of results to the most recent N usageDetails.
Global Parameters
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Increase logging verbosity to show all debug logs.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show this help message and exit.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Only show errors, suppressing warnings.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Output format.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
JMESPath query string. See http://jmespath.org/ for more information and examples.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Increase logging verbosity. Use --debug for full debug logs.
az eventhubs eventhub consumer-group show
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get a description for the specified consumer group.
az eventhubs eventhub consumer-group show [--consumer-group-name]
[--eventhub-name]
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]
Optional Parameters
The consumer group name.
The Event Hub name.
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.
The Namespace name.
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
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Increase logging verbosity to show all debug logs.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show this help message and exit.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Only show errors, suppressing warnings.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Output format.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
JMESPath query string. See http://jmespath.org/ for more information and examples.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Increase logging verbosity. Use --debug for full debug logs.
az eventhubs eventhub consumer-group update
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update an Event Hubs consumer group as a nested resource within a Namespace.
az eventhubs eventhub consumer-group update [--add]
[--consumer-group-name]
[--eventhub-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--namespace-name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--user-metadata]
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>.
The consumer group name.
The Event Hub name.
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.
The Namespace name.
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
.
User Metadata 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.
Global Parameters
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Increase logging verbosity to show all debug logs.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show this help message and exit.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Only show errors, suppressing warnings.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Output format.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
JMESPath query string. See http://jmespath.org/ for more information and examples.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Command group 'eventhubs eventhub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Submit and view feedback for