az eventhubs namespace application-group

Reference

Manages Application Groups for premium eventhubs namespace.

Commands

Name	Description	Type	Status
az eventhubs namespace application-group create	Creates an application group for an EventHub namespace.	Core	GA
az eventhubs namespace application-group delete	Delete an ApplicationGroup for a Namespace.	Core	GA
az eventhubs namespace application-group list	List a list of application groups for a Namespace.	Core	GA
az eventhubs namespace application-group policy	Append or Remove application group policies.	Core	GA
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.	Core	GA
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.	Core	GA
az eventhubs namespace application-group show	Get an ApplicationGroup for a Namespace.	Core	GA
az eventhubs namespace application-group update	Update an ApplicationGroup for a Namespace.	Core	GA

az eventhubs namespace application-group create

Edit

Creates an application group for an EventHub namespace.

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

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.

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

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

List of Throttling Policy Objects.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Edit

Delete an ApplicationGroup for a Namespace.

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

Optional Parameters

--application-group-name --name -n

The Application Group name.

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

--namespace-name

The Namespace name.

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Edit

List a list of application groups for a Namespace.

az eventhubs namespace application-group list --namespace-name
                                              --resource-group
                                              [--max-items]
                                              [--next-token]

Required Parameters

--namespace-name

The Namespace name.

--resource-group -g

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

Optional Parameters

--max-items

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.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Edit

Get an ApplicationGroup for a Namespace.

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

Optional Parameters

--application-group-name --name -n

The Application Group name.

--ids

--namespace-name

The Namespace name.

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Edit

Update an ApplicationGroup for a Namespace.

az eventhubs namespace application-group update [--add]
                                                [--application-group-name]
                                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--ids]
                                                [--is-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--namespace-name]
                                                [--policies]
                                                [--remove]
                                                [--resource-group]
                                                [--set]
                                                [--subscription]

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

--application-group-name --name -n

The Application Group name.

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ids

--is-enabled

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--namespace-name

The Namespace name.

--policies

List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> 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=<value>.

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Share via

az eventhubs namespace application-group

Commands

az eventhubs namespace application-group create

Examples

Required Parameters

Optional Parameters

az eventhubs namespace application-group delete

Optional Parameters

az eventhubs namespace application-group list

Required Parameters

Optional Parameters

az eventhubs namespace application-group show

Optional Parameters

az eventhubs namespace application-group update

Optional Parameters

Additional resources