Share via

az eventgrid partner 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 partner topics.

Commands

Name Description Type Status
az eventgrid partner topic activate

Activate a partner topic.

 Core GA
az eventgrid partner topic activate (eventgrid extension)

Activate a partner topic.

 Extension Preview
az eventgrid partner topic deactivate

Deactivate a partner topic.

 Core GA
az eventgrid partner topic deactivate (eventgrid extension)

Deactivate a partner topic.

 Extension Preview
az eventgrid partner topic delete

Delete a partner topic.

 Core GA
az eventgrid partner topic delete (eventgrid extension)

Delete a partner topic.

 Extension Preview
az eventgrid partner topic event-subscription

Manage event subscriptions of partner topic.

 Core and Extension GA
az eventgrid partner topic event-subscription create

Create a new event subscription for a partner topic.

 Core GA
az eventgrid partner topic event-subscription create (eventgrid extension)

Create a new event subscription for a partner topic.

 Extension Preview
az eventgrid partner topic event-subscription delete

Delete an event subscription of a partner topic.

 Core GA
az eventgrid partner topic event-subscription delete (eventgrid extension)

Delete an event subscription of a partner topic.

 Extension Preview
az eventgrid partner topic event-subscription list

List event subscriptions of a specific partner topic.

 Core GA
az eventgrid partner topic event-subscription list (eventgrid extension)

List event subscriptions of a specific partner topic.

 Extension Preview
az eventgrid partner topic event-subscription show

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

 Core GA
az eventgrid partner topic event-subscription show (eventgrid extension)

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

 Extension Preview
az eventgrid partner topic event-subscription update

Update an event subscription of a partner topic.

 Core GA
az eventgrid partner topic event-subscription update (eventgrid extension)

Update an event subscription of a partner topic.

 Extension Preview
az eventgrid partner topic list

List available partner topics.

 Core GA
az eventgrid partner topic list (eventgrid extension)

List available partner topics.

 Extension Preview
az eventgrid partner topic show

Get the details of a partner topic.

 Core GA
az eventgrid partner topic show (eventgrid extension)

Get the details of a partner topic.

 Extension Preview

az eventgrid partner topic activate

Edit

Activate a partner topic.

az eventgrid partner topic activate [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]

Examples

Activate a specific partner topic.

az eventgrid partner topic activate -g rg1 -n partnertopic1

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 partner 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 partner topic activate (eventgrid extension)

Preview

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

Activate a partner topic.

az eventgrid partner topic activate [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]

Examples

Activate a specific partner topic.

az eventgrid partner topic activate -g rg1 -n partnertopic1

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 partner 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 partner topic deactivate

Edit

Deactivate a partner topic.

az eventgrid partner topic deactivate [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

Examples

Deactivate a specific partner topic.

az eventgrid partner topic deactivate -g rg1 -n partnertopic1

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 partner 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 partner topic deactivate (eventgrid extension)

Preview

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

Deactivate a partner topic.

az eventgrid partner topic deactivate [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

Examples

Deactivate a specific partner topic.

az eventgrid partner topic deactivate -g rg1 -n partnertopic1

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

Edit

Delete a partner topic.

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

Examples

Delete a specific partner topic.

az eventgrid partner topic delete -g rg1 --name partnertopic1

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

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

Examples

Delete a specific partner topic.

az eventgrid partner topic delete -g rg1 --name partnertopic1

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

Edit

List available partner topics.

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

Examples

List all partner topics in the current Azure subscription.

az eventgrid partner topic list

List all partner topics in a resource group.

az eventgrid partner topic list -g rg1

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

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

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

az eventgrid partner 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 partner 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 partner topics.

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

Examples

List all partner topics in the current Azure subscription.

az eventgrid partner topic list

List all partner topics in a resource group.

az eventgrid partner topic list -g rg1

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

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

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

az eventgrid partner 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 partner topic show

Edit

Get the details of a partner topic.

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

Examples

Show the details of a partner topic.

az eventgrid partner topic show -g rg1 -n partnertopic1

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

az eventgrid partner topic show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/partnetopics/topic1

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

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

Examples

Show the details of a partner topic.

az eventgrid partner topic show -g rg1 -n partnertopic1

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

az eventgrid partner topic show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/partnetopics/topic1

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