az eventgrid domain topic

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage event domain topics.

Commands

Name Description Type Status
az eventgrid domain topic create

Create a domain topic under a domain.

 Core GA
az eventgrid domain topic create (eventgrid extension)

Create a domain topic under a domain.

 Extension Preview
az eventgrid domain topic delete

Delete a domain topic under a domain.

 Core GA
az eventgrid domain topic delete (eventgrid extension)

Delete a domain topic under a domain.

 Extension Preview
az eventgrid domain topic event-subscription

Manage event subscriptions of a domain topic.

 Core GA
az eventgrid domain topic event-subscription create

Create a new event subscription for a domain topic.

 Core GA
az eventgrid domain topic event-subscription delete

Delete an event subscription of a domain topic.

 Core GA
az eventgrid domain topic event-subscription list

List event subscriptions of a specific domain topic.

 Core GA
az eventgrid domain topic event-subscription show

Get the details of an event subscription of a domain topic.

 Core GA
az eventgrid domain topic event-subscription update

Update an event subscription of a domain topic.

 Core GA
az eventgrid domain topic list

List available topics in a domain.

 Core GA
az eventgrid domain topic list (eventgrid extension)

List available topics in a domain.

 Extension Preview
az eventgrid domain topic show

Get the details of a domain topic.

 Core GA
az eventgrid domain topic show (eventgrid extension)

Get the details of a domain topic.

 Extension Preview

az eventgrid domain topic create

Edit

Create a domain topic under a domain.

az eventgrid domain topic create --domain-name
                                 --name
                                 --resource-group

Examples

Create a new domain topic under domain.

az eventgrid domain topic create -g rg1 --domain-name domain1 --name domaintopic1

Required Parameters

--domain-name

Name of the domain.

--name -n

Name of the domain topic.

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

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 eventgrid domain topic create (eventgrid extension)

Preview

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

Create a domain topic under a domain.

az eventgrid domain topic create --domain-name
                                 --name
                                 --resource-group

Examples

Create a new domain topic under domain.

az eventgrid domain topic create -g rg1 --domain-name domain1 --name domaintopic1

Required Parameters

--domain-name

Name of the domain.

--name -n

Name of the domain topic.

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

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 eventgrid domain topic delete

Edit

Delete a domain topic under a domain.

az eventgrid domain topic delete [--domain-name]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

Examples

Delete a domain topic.

az eventgrid domain topic delete -g rg1 --domain-name domain1 --name domaintopic1

Optional Parameters

--domain-name

Name of the domain.

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

--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 eventgrid domain topic delete (eventgrid extension)

Preview

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

Delete a domain topic under a domain.

az eventgrid domain topic delete [--domain-name]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

Examples

Delete a domain topic.

az eventgrid domain topic delete -g rg1 --domain-name domain1 --name domaintopic1

Optional Parameters

--domain-name

Name of the domain.

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

--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 eventgrid domain topic list

Edit

List available topics in a domain.

az eventgrid domain topic list --domain-name
                               --resource-group
                               [--odata-query]

Examples

List all topics in a domain.

az eventgrid domain topic list -g rg1 --domain-name domain1

List all domain topics in a domain whose name contains the pattern "XYZ"

az eventgrid domain topic list -g rg1 --domain-name domain1 --odata-query "Contains(name, 'XYZ')"

List all domain topics in a domain except the domain topic with name "name1"

az eventgrid domain topic list -g rg1 --domain-name domain1 --odata-query "NOT (name eq 'name1')"

Required Parameters

--domain-name

Name of the domain.

--resource-group -g

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

Optional Parameters

--odata-query

The OData query used for filtering the list results. Filtering is currently allowed on the Name property only. The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT.

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 eventgrid domain topic list (eventgrid extension)

Preview

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

List available topics in a domain.

az eventgrid domain topic list --domain-name
                               --resource-group
                               [--odata-query]

Examples

List all topics in a domain.

az eventgrid domain topic list -g rg1 --domain-name domain1

List all domain topics in a domain whose name contains the pattern "XYZ"

az eventgrid domain topic list -g rg1 --domain-name domain1 --odata-query "Contains(name, 'XYZ')"

List all domain topics in a domain except the domain topic with name "name1"

az eventgrid domain topic list -g rg1 --domain-name domain1 --odata-query "NOT (name eq 'name1')"

Required Parameters

--domain-name

Name of the domain.

--resource-group -g

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

Optional Parameters

--odata-query

The query used to filter the results using OData syntax.

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 eventgrid domain topic show

Edit

Get the details of a domain topic.

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

Examples

Show the details of a domain topic.

az eventgrid domain topic show -g rg1 --domain-name domain1 --name topic1

Optional Parameters

--domain-name

Name of the domain.

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

--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 eventgrid domain topic show (eventgrid extension)

Preview

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

Get the details of a domain topic.

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

Examples

Show the details of a domain topic.

az eventgrid domain topic show -g rg1 --domain-name domain1 --name topic1

Optional Parameters

--domain-name

Name of the domain.

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

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