Share via

az servicebus topic subscription rule

  • Reference

Servicebus topic subscription rule.

Commands

Name Description Type Status
az servicebus topic subscription rule create

Create the ServiceBus Rule for Subscription.

 Core GA
az servicebus topic subscription rule delete

Delete an existing rule.

 Core GA
az servicebus topic subscription rule list

List all the rules within given topic-subscription.

 Core GA
az servicebus topic subscription rule show

Get the description for the specified rule.

 Core GA
az servicebus topic subscription rule update

Update a new rule and updates an existing rule.

 Core GA

az servicebus topic subscription rule create

Edit

Create the ServiceBus Rule for Subscription.

az servicebus topic subscription rule create --name
                                             --namespace-name
                                             --resource-group
                                             --subscription-name
                                             --topic-name
                                             [--action-compatibility-level]
                                             [--action-sql-expression]
                                             [--content-type]
                                             [--correlation-filter]
                                             [--correlation-id]
                                             [--enable-action-preprocessing {false, true}]
                                             [--enable-correlation-preprocessing {false, true}]
                                             [--enable-sql-preprocessing {false, true}]
                                             [--filter-sql-expression]
                                             [--filter-type {CorrelationFilter, SqlFilter}]
                                             [--label]
                                             [--message-id]
                                             [--no-wait]
                                             [--reply-to]
                                             [--reply-to-session-id]
                                             [--session-id]
                                             [--to]

Examples

Create Rule.

az servicebus topic subscription rule create --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --subscription-name mysubscription --name myrule --filter-sql-expression myproperty=myvalue

Required Parameters

--name -n

Name of Rule.

--namespace-name

Name of Namespace.

--resource-group -g

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

--subscription-name

Name of Subscription.

--topic-name

Name of Topic.

Optional Parameters

--action-compatibility-level

This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.

--action-sql-expression

Action SQL expression.

--content-type

Content type of message.

--correlation-filter --correlation-filter-property

Dictionary object for custom filters.

--correlation-id

Identifier of correlation.

--enable-action-preprocessing

A boolean value that indicates whether the rule action requires preprocessing.

Accepted values: false, true
--enable-correlation-preprocessing

A boolean value that indicates whether the rule action requires preprocessing.

Accepted values: false, true
--enable-sql-preprocessing

A boolean value that indicates whether the rule action requires preprocessing.

Accepted values: false, true
--filter-sql-expression

SQL expression. e.g. myproperty=test.

--filter-type

Rule Filter types.

Accepted values: CorrelationFilter, SqlFilter
--label

Application specific label.

--message-id

Identifier of message.

--no-wait

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

Default value: False
--reply-to

Address of the queue to reply to.

--reply-to-session-id

Session identifier to reply to.

--session-id

Session identifier.

--to

Address to send to.

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 servicebus topic subscription rule delete

Edit

Delete an existing rule.

az servicebus topic subscription rule delete [--ids]
                                             [--name]
                                             [--namespace-name]
                                             [--resource-group]
                                             [--subscription]
                                             [--subscription-name]
                                             [--topic-name]

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

The rule name.

--namespace-name

The namespace name.

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

--subscription-name

The subscription name.

--topic-name

The topic 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 servicebus topic subscription rule list

Edit

List all the rules within given topic-subscription.

az servicebus topic subscription rule list --namespace-name
                                           --resource-group
                                           --subscription-name
                                           --topic-name
                                           [--skip]
                                           [--top]

Required Parameters

--namespace-name

The namespace name.

--resource-group -g

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

--subscription-name

The subscription name.

--topic-name

The topic name.

Optional Parameters

--skip

Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

--top

May be used to limit the number of results to the most recent N usageDetails.

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 servicebus topic subscription rule show

Edit

Get the description for the specified rule.

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

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

The rule name.

--namespace-name

The namespace name.

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

--subscription-name

The subscription name.

--topic-name

The topic 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 servicebus topic subscription rule update

Edit

Update a new rule and updates an existing rule.

az servicebus topic subscription rule update [--action-compatibility-level]
                                             [--action-preprocessing {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--action-sql-expression]
                                             [--add]
                                             [--compatibility-level]
                                             [--content-type]
                                             [--correlation-id]
                                             [--enable-correlation-preprocessing {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--enable-sql-preprocessing {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--filter-sql-expression]
                                             [--filter-type {CorrelationFilter, SqlFilter}]
                                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--ids]
                                             [--label]
                                             [--message-id]
                                             [--name]
                                             [--namespace-name]
                                             [--properties]
                                             [--remove]
                                             [--reply-to]
                                             [--reply-to-session-id]
                                             [--resource-group]
                                             [--session-id]
                                             [--set]
                                             [--subscription]
                                             [--subscription-name]
                                             [--to]
                                             [--topic-name]

Optional Parameters

--action-compatibility-level

This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.

--action-preprocessing --enable-action-preprocessing

Value that indicates whether the rule action requires preprocessing.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--action-sql-expression

SQL expression. e.g. MyProperty='ABC'.

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

--compatibility-level

This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.

--content-type

Content type of the message.

--correlation-id

Identifier of the correlation.

--enable-correlation-preprocessing --requires-preprocessing

Value that indicates whether the rule action requires preprocessing.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-sql-preprocessing -f

Value that indicates whether the rule action requires preprocessing.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--filter-sql-expression --sql-expression

The SQL expression. e.g. MyProperty='ABC'.

--filter-type

Filter type that is evaluated against a BrokeredMessage.

Accepted values: CorrelationFilter, SqlFilter
--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--label

Application specific label.

--message-id

Identifier of the message.

--name --rule-name -n

The rule name.

--namespace-name

The namespace name.

--properties

Dictionary object for custom filters Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

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

--reply-to

Address of the queue to reply to.

--reply-to-session-id

Session identifier to reply to.

--resource-group -g

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

--session-id

Session identifier.

--set

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

--subscription

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

--subscription-name

The subscription name.

--to

Address to send to.

--topic-name

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