az eventhubs namespace application-group

Manages Application Groups for premium eventhubs namespace.

Commands

az eventhubs namespace application-group create	Creates an application group for an EventHub namespace.
az eventhubs namespace application-group delete	Deletes an ApplicationGroup for a Namespace.
az eventhubs namespace application-group list	Lists all application groups in an EventHub namespace.
az eventhubs namespace application-group policy	Append or Remove application group policies.
az eventhubs namespace application-group policy add	Appends an application group policy to the existing policy. This cmdlet can be used to append one or more throttling policies.
az eventhubs namespace application-group policy remove	Removes an application group policy from the existing policies. This cmdlet can be used to remove one or more throttling policies.
az eventhubs namespace application-group show	Gets an application group in an EventHub namespace.
az eventhubs namespace application-group update	Updates an application group in an EventHub namespace.

az eventhubs namespace application-group create

Creates an application group for an EventHub namespace.

az eventhubs namespace application-group create --client-app-group-id
                                                --name
                                                --namespace-name
                                                --policy-config
                                                --resource-group
                                                [--is-enabled {false, true}]

Examples

Create an application group myAppGroup for eventhub namespace mynamespace with 2 throttling policies. Maximum allowed throttling policies is 4.

az eventhubs namespace application-group create --namespace-name mynamespace -g MyResourceGroup --name myAppGroup --client-app-group-identifier NamespaceSASKeyName=keyname --throttling-policy-config name=policy1 metric-id=IncomingMessages rate-limit-threshold=10000 --throttling-policy-config name=policy2 metric-id=IncomingBytes rate-limit-threshold=20000

Required Parameters

--client-app-group-id --client-app-group-identifier

The Unique identifier for application group.Supports SAS(NamespaceSASKeyName=KeyName or EntitySASKeyName=KeyName) or AAD(AADAppID=Guid).

--name -n

Name of Application Group.

--namespace-name

Name of Namespace.

--policy-config --throttling-policy --throttling-policy-config

List of Throttling Policy Objects.

--resource-group -g

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

Optional Parameters

--is-enabled

Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed.

accepted values: false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs namespace application-group delete

Deletes an ApplicationGroup for a Namespace.

az eventhubs namespace application-group delete [--ids]
                                                [--name]
                                                [--namespace-name]
                                                [--resource-group]
                                                [--subscription]

Optional Parameters

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

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs namespace application-group list

Lists all application groups in an EventHub namespace.

az eventhubs namespace application-group list --namespace-name
                                              --resource-group

Examples

Lists all application groups in eventhub namespace mynamespace.

az eventhubs namespace application-group list --namespace-name mynamespace -g MyResourceGroup

Required Parameters

--namespace-name

Name of Namespace.

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs namespace application-group show

Gets an application group in an EventHub namespace.

az eventhubs namespace application-group show [--ids]
                                              [--name]
                                              [--namespace-name]
                                              [--resource-group]
                                              [--subscription]

Examples

Gets an application group myAppGroup for eventhub namespace mynamespace.

az eventhubs namespace application-group show --namespace-name mynamespace -g MyResourceGroup --name myAppGroup

Optional Parameters

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

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventhubs namespace application-group update

Updates an application group in an EventHub namespace.

az eventhubs namespace application-group update [--ids]
                                                [--is-enabled {false, true}]
                                                [--name]
                                                [--namespace-name]
                                                [--resource-group]
                                                [--subscription]

Examples

Updates an application group myAppGroup for eventhub namespace mynamespace.

az eventhubs namespace application-group update --namespace-name mynamespace -g MyResourceGroup --name myAppGroup --is-enabled false

Optional Parameters

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

--is-enabled

Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed.

accepted values: false, true

--name -n

Name of Application Group.

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.