Share via

az eventgrid partner topic

Manage partner topics.

Commands

Name Description Type Status
az eventgrid partner topic activate

Activate a partner topic.

 Core GA
az eventgrid partner topic deactivate

Deactivate a partner topic.

 Core GA
az eventgrid partner topic delete

Delete a partner topic.

 Core GA
az eventgrid partner topic event-subscription

Manage event subscriptions of partner topic.

 Core 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 delete

Delete an event subscription of a partner topic.

 Core GA
az eventgrid partner topic event-subscription list

List event subscriptions of a specific partner topic.

 Core GA
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 update

Update an event subscription of a partner topic.

 Core GA
az eventgrid partner topic list

List available partner topics.

 Core GA
az eventgrid partner topic show

Get the details of a partner topic.

 Core GA

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

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

Name of the partner topic.

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

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

Name of the partner topic.

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

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

Name of the partner topic.

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

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

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

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

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

Name of the partner topic.

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