az eventgrid system-topic

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

Commands

Name	Description	Type	Status
az eventgrid system-topic create	Create a system topic.	Core	GA
az eventgrid system-topic create (eventgrid extension)	Create a system topic.	Extension	Preview
az eventgrid system-topic delete	Delete a system topic.	Core	GA
az eventgrid system-topic delete (eventgrid extension)	Delete a system topic.	Extension	Preview
az eventgrid system-topic event-subscription	Manage event subscriptions of system topic.	Core and Extension	GA
az eventgrid system-topic event-subscription create	Create a new event subscription for a system topic.	Core	GA
az eventgrid system-topic event-subscription create (eventgrid extension)	Create a new event subscription for a system topic.	Extension	Preview
az eventgrid system-topic event-subscription delete	Delete an event subscription of a system topic.	Core	GA
az eventgrid system-topic event-subscription delete (eventgrid extension)	Delete an event subscription of a system topic.	Extension	Preview
az eventgrid system-topic event-subscription list	List event subscriptions of a specific system topic.	Core	GA
az eventgrid system-topic event-subscription list (eventgrid extension)	List event subscriptions of a specific system topic.	Extension	Preview
az eventgrid system-topic event-subscription show	Get the details of an event subscription of a system topic.	Core	GA
az eventgrid system-topic event-subscription show (eventgrid extension)	Get the details of an event subscription of a system topic.	Extension	Preview
az eventgrid system-topic event-subscription update	Update an event subscription of a system topic.	Core	GA
az eventgrid system-topic event-subscription update (eventgrid extension)	Update an event subscription of a system topic.	Extension	Preview
az eventgrid system-topic list	List available system topics.	Core	GA
az eventgrid system-topic list (eventgrid extension)	List available system topics.	Extension	Preview
az eventgrid system-topic show	Get the details of a system topic.	Core	GA
az eventgrid system-topic show (eventgrid extension)	Get the details of a system topic.	Extension	Preview
az eventgrid system-topic update	Update a system topic.	Core	GA
az eventgrid system-topic update (eventgrid extension)	Update a system topic.	Extension	Preview

az eventgrid system-topic create

Create a system topic.

az eventgrid system-topic create --name
                                 --resource-group
                                 --source
                                 --topic-type
                                 [--identity {noidentity, systemassigned}]
                                 [--location]
                                 [--mi-system-assigned]
                                 [--mi-user-assigned]
                                 [--tags]

Examples

Create a new system topic for storage account source.

az eventgrid system-topic create -g rg1 --name systemtopic1 --location westus2 --topic-type microsoft.storage.storageaccounts --source /subscriptions/1b3b4501-23b9-4790-c31b-ddbd88d72123/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/stgaccountname

Create a new system topic with systemassigned identity

az eventgrid system-topic create -g rg1 --name systemtopic1 --location westus2 --topic-type microsoft.storage.storageaccounts --source /subscriptions/1b3b4501-23b9-4790-c31b-ddbd88d72123/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/stgaccountname --identity systemassigned

Required Parameters

--name -n

Name of the system topic.

--resource-group -g

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

--source

The ARM Id for the topic, e.g., /subscriptions/{SubId}/resourceGroups/{RgName}/providers/Microsoft.Storage/storageAccounts/{AccountName}.

--topic-type

Name of the topic type.

Optional Parameters

--identity

Preview Deprecated

Argument 'identity' has been deprecated and will be removed in a future release.

The managed identity type for the resource. Will be deprecated and replaced by --mi-system-assigned-identity in future.

accepted values: noidentity, systemassigned

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--mi-system-assigned

Presence of this param indicates that SystemAssigned managed identity will be used.

--mi-user-assigned

Preview

Add user assigned identities when identityType is user or mixed. This attribute is valid for all destination types except StorageQueue. Multiple attributes can be specified by using more than one --mi-user-assigned argument.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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

az eventgrid system-topic create --location
                                 --name
                                 --resource-group
                                 --source
                                 --topic-type
                                 [--tags]

Examples

Create a new system topic for storage account source.

az eventgrid system-topic create -g rg1 --name systemtopic1 --location westus2 --topic-type microsoft.storage.storageaccounts --source /subscriptions/1b3b4501-23b9-4790-c31b-ddbd88d72123/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/stgaccountname

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

Name of the system topic.

--resource-group -g

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

--source

The ARM Id for the topic, e.g., /subscriptions/{SubId}/resourceGroups/{RgName}/providers/Microsoft.Storage/storageAccounts/{AccountName}.

--topic-type

Name of the topic type.

Optional Parameters

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 system-topic delete

Delete a system topic.

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

Examples

Delete a specific system topic.

az eventgrid system-topic delete -g rg1 --name systemtopic1

Optional Parameters

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

--yes -y

Do not prompt for confirmation.

default value: False

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

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

Examples

Delete a specific system topic.

az eventgrid system-topic delete -g rg1 --name systemtopic1

Optional Parameters

--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 system 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 system-topic list

List available system topics.

az eventgrid system-topic list [--odata-query]
                               [--resource-group]

Examples

List all system topics in the current Azure subscription.

az eventgrid system-topic list

List all system topics in a resource group.

az eventgrid system-topic list -g rg1

List all system topics in a resource group whose name contains the pattern "XYZ"

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

List all system topics in a resource group except the system topic with name "name1"

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

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.

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

az eventgrid system-topic list [--odata-query]
                               [--resource-group]

Examples

List all system topics in the current Azure subscription.

az eventgrid system-topic list

List all system topics in a resource group.

az eventgrid system-topic list -g rg1

List all system topics in a resource group whose name contains the pattern "XYZ"

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

List all system topics in a resource group except the system topic with name "name1"

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

Optional Parameters

--odata-query

The query used to filter the results using OData syntax.

--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 system-topic show

Get the details of a system topic.

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

Examples

Show the details of a system topic.

az eventgrid system-topic show -g rg1 -n systemtopic1

Show the details of a system topic based on resource ID.

az eventgrid system-topic show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/systemtopics/systemtopic1

Optional Parameters

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

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

Examples

Show the details of a system topic.

az eventgrid system-topic show -g rg1 -n systemtopic1

Show the details of a system topic based on resource ID.

az eventgrid system-topic show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/systemtopics/systemtopic1

Optional Parameters

--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 system 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 system-topic update

Update a system topic.

az eventgrid system-topic update [--identity {noidentity, systemassigned}]
                                 [--ids]
                                 [--mi-system-assigned]
                                 [--mi-user-assigned]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--tags]

Examples

Update the properties of an existing system topic.

az eventgrid system-topic update -g rg1 --name systemtopic1 --tags Dept=IT

Update the identity of an existing system topic.

az eventgrid system-topic update -g rg1 --name systemtopic1 --identity systemassigned

Optional Parameters

--identity

Preview Deprecated

Argument 'identity' has been deprecated and will be removed in a future release.

The managed identity type for the resource. Will be deprecated and replaced by --mi-system-assigned-identity in future.

accepted values: noidentity, systemassigned

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

--mi-system-assigned

Presence of this param indicates that SystemAssigned managed identity will be used.

--mi-user-assigned

Preview

Add user assigned identities when identityType is user or mixed. This attribute is valid for all destination types except StorageQueue. Multiple attributes can be specified by using more than one --mi-user-assigned argument.

--name -n

Name of the system 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.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 system-topic update (eventgrid extension)

Preview

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

Update a system topic.

az eventgrid system-topic update [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--tags]

Examples

Update the properties of an existing system topic.

az eventgrid system-topic update -g rg1 --name systemtopic1 --tags Dept=IT

Optional Parameters

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.