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
                                            [--subscription]
                                            [--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

--eventhub-name

Name of EventHub.

--name -n

Name of ConsumerGroup.

--namespace-name

Name of Namespace.

--resource-group -g

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

Optional Parameters

--subscription

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

--user-metadata

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.

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

--eventhub-name

Name of EventHub.

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

--name -n

Name of ConsumerGroup.

--namespace-name

Name of Namespace.

--resource-group -g

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

--subscription

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

az eventhubs eventhub consumer-group list

List the ConsumerGroup by Eventhub.

az eventhubs eventhub consumer-group list --eventhub-name
                                          --namespace-name
                                          --resource-group
                                          [--query-examples]
                                          [--skip]
                                          [--subscription]
                                          [--top]

Examples

List the ConsumerGroup by Eventhub.

az eventhubs eventhub consumer-group list --resource-group myresourcegroup --namespace-name mynamespace --eventhub-name myeventhub

Required Parameters

--eventhub-name

Name of EventHub.

--namespace-name

Name of Namespace.

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

--skip

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.

--subscription

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

--top

May be used to limit the number of results to the most recent N usageDetails.

az eventhubs eventhub consumer-group show

Shows the ConsumerGroup Details.

az eventhubs eventhub consumer-group show [--eventhub-name]
                                          [--ids]
                                          [--name]
                                          [--namespace-name]
                                          [--query-examples]
                                          [--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

--eventhub-name

Name of EventHub.

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

--name -n

Name of ConsumerGroup.

--namespace-name

Name of Namespace.

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

--resource-group -g

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

--subscription

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

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

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

--eventhub-name

Name of EventHub.

--force-string

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

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

--name -n

Name of ConsumerGroup.

--namespace-name

Name of Namespace.

--remove

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

--resource-group -g

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

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

--user-metadata

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.