az eventgrid namespace client-group
Note
This reference is part of the eventgrid extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az eventgrid namespace client-group command. Learn more about extensions.
Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage eventgrid namespace client-group.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az eventgrid namespace client-group create |
Create a client group. |
Extension | Preview |
| az eventgrid namespace client-group delete |
Delete an existing client group. |
Extension | Preview |
| az eventgrid namespace client-group list |
List all the client groups under a namespace. |
Extension | Preview |
| az eventgrid namespace client-group show |
Show a client group. |
Extension | Preview |
| az eventgrid namespace client-group update |
Update a client group. |
Extension | Preview |
| az eventgrid namespace client-group wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az eventgrid namespace client-group create
Command group 'az eventgrid namespace client-group' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a client group.
az eventgrid namespace client-group create --client-group-name
--namespace-name
--resource-group
[--description]
[--group-query]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]Examples
Create client group
az eventgrid namespace client-group create -g rg --namespace-name name -n client-group --group-query "attributes.floor=6"Required Parameters
The client group name.
Name of the namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Description for the Client Group resource.
The grouping query for the clients.
Do not wait for the long-running operation to finish.
Global Parameters
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 eventgrid namespace client-group delete
Command group 'az eventgrid namespace client-group' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete an existing client group.
az eventgrid namespace client-group delete [--client-group-name]
[--ids]
[--namespace-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Examples
Delete client group
az eventgrid namespace client-group delete -g rg --namespace-name name -n client-groupOptional Parameters
Name of the client group.
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 the namespace.
Do not wait for the long-running operation to finish.
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.
Do not prompt for confirmation.
Global Parameters
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 eventgrid namespace client-group list
Command group 'az eventgrid namespace client-group' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List all the client groups under a namespace.
az eventgrid namespace client-group list --namespace-name
--resource-group
[--filter]
[--max-items]
[--next-token]
[--top]Examples
List client group
az eventgrid namespace client-group list -g rg --namespace-name nameRequired Parameters
Name of the namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.
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.
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.
Global Parameters
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 eventgrid namespace client-group show
Command group 'az eventgrid namespace client-group' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show a client group.
az eventgrid namespace client-group show [--client-group-name]
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]Examples
Show client group
az eventgrid namespace client-group show -g rg --namespace-name name -n client-groupOptional Parameters
Name of the client group.
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 the 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.
Global Parameters
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 eventgrid namespace client-group update
Command group 'az eventgrid namespace client-group' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update a client group.
az eventgrid namespace client-group update [--add]
[--client-group-name]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--group-query]
[--ids]
[--namespace-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--subscription]Examples
update client group
az eventgrid namespace client-group update -g rg --namespace-name name -n client-group --description testOptional 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 the client group.
Description for the Client Group resource.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The grouping query for the clients.
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 the namespace.
Do not wait for the long-running operation to finish.
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.
Global Parameters
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 eventgrid namespace client-group wait
Command group 'az eventgrid namespace client-group' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition is met.
az eventgrid namespace client-group wait [--client-group-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--namespace-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Name of the client group.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of the 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.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
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
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for