az eventgrid namespace topic

Preview

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

Commands

Name	Description	Type	Status
az eventgrid namespace topic create	Create a new namespace topic.	Extension	Preview
az eventgrid namespace topic delete	Delete existing namespace topic.	Extension	Preview
az eventgrid namespace topic event-subscription	Manage eventgrid namespace topic event subscription.	Extension	Preview
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 list	List all the namespace topics under a namespace.	Extension	Preview
az eventgrid namespace topic list-key	List the two keys used to publish to a namespace topic.	Extension	Preview
az eventgrid namespace topic regenerate-key	Regenerate a shared access key for a namespace topic.	Extension	Preview
az eventgrid namespace topic show	Show a namespace topic.	Extension	Preview
az eventgrid namespace topic update	Update a namespace topic.	Extension	Preview
az eventgrid namespace topic wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az eventgrid namespace topic create

Preview

Command group 'az eventgrid namespace topic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a new namespace topic.

az eventgrid namespace topic create --name --topic-name
                                    --namespace-name
                                    --resource-group
                                    [--event-retention-in-days]
                                    [--input-schema {CloudEventSchemaV1_0}]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--publisher-type {Custom}]

Examples

Create topic

az eventgrid namespace topic create -g rg -n topic --namespace-name name --event-retention-in-days 1 --publisher-type custom

Required Parameters

--name --topic-name -n

Name of the namespace topic.

--namespace-name

Name of the namespace.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-retention-in-days

Event retention for the namespace topic expressed in days.

Property	Value
Parameter group:	Properties Arguments

--input-schema

This determines the format that is expected for incoming events published to the topic.

Property	Value
Parameter group:	Properties Arguments
Default value:	CloudEventSchemaV1_0
Accepted values:	CloudEventSchemaV1_0

--no-wait

Do not wait for the long-running operation to finish.

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

--publisher-type

Publisher type of the namespace topic.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Custom

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az eventgrid namespace topic delete

Preview

Command group 'az eventgrid namespace topic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete existing namespace topic.

az eventgrid namespace topic delete [--ids]
                                    [--name --topic-name]
                                    [--namespace-name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--subscription]
                                    [--yes]

Examples

Delete topic

az eventgrid namespace topic delete -g rg -n topic --namespace-name name

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name --topic-name -n

Name of the topic.

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

Name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventgrid namespace topic list

Preview

Command group 'az eventgrid namespace topic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all the namespace topics under a namespace.

az eventgrid namespace topic list --namespace-name
                                  --resource-group
                                  [--filter]
                                  [--max-items]
                                  [--next-token]
                                  [--top]

Examples

List topic

az eventgrid namespace topic list -g rg --namespace-name name

Required Parameters

--namespace-name

Name of the namespace.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

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

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination Arguments

--top

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

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az eventgrid namespace topic list-key

Preview

Command group 'az eventgrid namespace topic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the two keys used to publish to a namespace topic.

az eventgrid namespace topic list-key [--ids]
                                      [--namespace-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--topic-name]

Examples

List key

az eventgrid namespace topic list-key -g rg --topic-name topic --namespace-name name

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

Name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--topic-name

Name of the topic.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventgrid namespace topic regenerate-key

Preview

Command group 'az eventgrid namespace topic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Regenerate a shared access key for a namespace topic.

az eventgrid namespace topic regenerate-key --key-name
                                            [--ids]
                                            [--namespace-name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]
                                            [--topic-name]

Examples

Regenerate key

az eventgrid namespace topic regenerate-key -g rg --topic-name topic --namespace-name name --key-name key1

Required Parameters

--key-name

Key name to regenerate key1 or key2.

Property	Value
Parameter group:	RegenerateKeyRequest Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

Name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--topic-name

Name of the topic.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventgrid namespace topic show

Preview

Command group 'az eventgrid namespace topic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show a namespace topic.

az eventgrid namespace topic show [--ids]
                                  [--name --topic-name]
                                  [--namespace-name]
                                  [--resource-group]
                                  [--subscription]

Examples

Show topic

az eventgrid namespace topic show -g rg -n topic --namespace-name name

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --topic-name -n

Name of the namespace topic.

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

Name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventgrid namespace topic update

Preview

Command group 'az eventgrid namespace topic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a namespace topic.

az eventgrid namespace topic update [--add]
                                    [--event-retention-in-days]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--ids]
                                    [--input-schema {CloudEventSchemaV1_0}]
                                    [--name --topic-name]
                                    [--namespace-name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--publisher-type {Custom}]
                                    [--remove]
                                    [--resource-group]
                                    [--set]
                                    [--subscription]

Examples

Update topic

az eventgrid namespace topic create -g rg -n topic --namespace-name name --input-schema CloudEventSchemaV1_0

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

--event-retention-in-days

Event retention for the namespace topic expressed in days.

Property	Value
Parameter group:	Properties Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--input-schema

This determines the format that is expected for incoming events published to the topic.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	CloudEventSchemaV1_0

--name --topic-name -n

Name of the namespace topic.

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

Name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

--publisher-type

Publisher type of the namespace topic.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Custom

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventgrid namespace topic wait

Preview

Command group 'az eventgrid namespace topic' 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 wait [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--ids]
                                  [--interval]
                                  [--name --topic-name]
                                  [--namespace-name]
                                  [--resource-group]
                                  [--subscription]
                                  [--timeout]
                                  [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --topic-name -n

Name of the namespace topic.

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

Name of the namespace.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

Share via

az eventgrid namespace topic

Commands

az eventgrid namespace topic create

Examples

Required Parameters

Optional Parameters

az eventgrid namespace topic delete

Examples

Optional Parameters

az eventgrid namespace topic list

Examples

Required Parameters

Optional Parameters

az eventgrid namespace topic list-key

Examples

Optional Parameters

az eventgrid namespace topic regenerate-key

Examples

Required Parameters

Optional Parameters

az eventgrid namespace topic show

Examples

Optional Parameters

az eventgrid namespace topic update

Examples

Optional Parameters

az eventgrid namespace topic wait

Optional Parameters

Feedback