az eventgrid namespace topic event-subscription
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 topic event-subscription command. Learn more about extensions.
Command group 'az eventgrid namespace topic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage eventgrid namespace topic event subscription.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az eventgrid namespace topic event-subscription create |
Create an event subscription of a namespace topic. |
Extension | Preview |
| az eventgrid namespace topic event-subscription delete |
Delete an existing event subscription of a namespace topic. |
Extension | Preview |
| az eventgrid namespace topic event-subscription list |
List event subscriptions that belong to a specific namespace topic. |
Extension | Preview |
| az eventgrid namespace topic event-subscription show |
Show an event subscription of a namespace topic. |
Extension | Preview |
| az eventgrid namespace topic event-subscription update |
Update an event subscription of a namespace topic. |
Extension | Preview |
| az eventgrid namespace topic event-subscription wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az eventgrid namespace topic event-subscription create
Command group 'az eventgrid namespace topic event-subscription' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create an event subscription of a namespace topic.
az eventgrid namespace topic event-subscription create --event-subscription-name
--namespace-name
--resource-group
--topic-name
[--delivery-configuration]
[--event-delivery-schema {CloudEventSchemaV1_0}]
[--filters-configuration]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]Examples
Create event subscription
az eventgrid namespace topic event-subscription create -g rg --topic-name topic -n event-subscription --namespace-name name --delivery-configuration "{deliveryMode:Queue,queue:{receiveLockDurationInSeconds:60,maxDeliveryCount:4,eventTimeToLive:P1D}}"Required Parameters
Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
Name of the namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the namespace topic.
Optional Parameters
Information about the delivery configuration of the event subscription. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The event delivery schema for the event subscription.
Information about the filter for the event subscription. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 topic event-subscription delete
Command group 'az eventgrid namespace topic event-subscription' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete an existing event subscription of a namespace topic.
az eventgrid namespace topic event-subscription delete [--event-subscription-name]
[--ids]
[--namespace-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--topic-name]
[--yes]Examples
Delete event subscription
az eventgrid namespace topic event-subscription delete -g rg --topic-name topic -n event-subscription --namespace-name nameRequired Parameters
Optional Parameters
Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
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.
Name of the namespace topic.
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 topic event-subscription list
Command group 'az eventgrid namespace topic event-subscription' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List event subscriptions that belong to a specific namespace topic.
az eventgrid namespace topic event-subscription list --namespace-name
--resource-group
--topic-name
[--filter]
[--max-items]
[--next-token]
[--top]Examples
List event subscription
az eventgrid namespace topic event-subscription list -g rg --topic-name topic --namespace-name nameRequired Parameters
Name of the namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the namespace topic.
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 topic event-subscription show
Command group 'az eventgrid namespace topic event-subscription' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show an event subscription of a namespace topic.
az eventgrid namespace topic event-subscription show [--event-subscription-name]
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]
[--topic-name]Examples
Show event subscription
az eventgrid namespace topic event-subscription show -g rg --topic-name topic -n event-subscription --namespace-name nameRequired Parameters
Optional Parameters
Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
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.
Name of the namespace topic.
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 topic event-subscription update
Command group 'az eventgrid namespace topic event-subscription' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update an event subscription of a namespace topic.
az eventgrid namespace topic event-subscription update [--add]
[--delivery-configuration]
[--event-delivery-schema {CloudEventSchemaV1_0}]
[--event-subscription-name]
[--filters-configuration]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--namespace-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--topic-name]Examples
Update event subscription
az eventgrid namespace topic event-subscription create -g rg --topic-name topic -n event-subscription --namespace-name name --filters-configuration "{includedEventTypes:['All']}"Required Parameters
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>.
Information about the delivery configuration of the event subscription. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The event delivery schema for the event subscription.
Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
Information about the filter for the event subscription. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
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.
Name of the namespace topic.
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 topic event-subscription wait
Command group 'az eventgrid namespace topic event-subscription' 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 topic event-subscription wait [--created]
[--custom]
[--deleted]
[--event-subscription-name]
[--exists]
[--ids]
[--interval]
[--namespace-name]
[--resource-group]
[--subscription]
[--timeout]
[--topic-name]
[--updated]Examples
Required Parameters
Optional Parameters
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.
Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
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.
Name of the namespace topic.
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.
