Share via

az servicebus topic subscription rule

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-filter-property]
                                             [--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

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

--action-compatibility-level

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

Property Value
Parameter group: Action Arguments
--action-sql-expression

Action SQL expression.

Property Value
Parameter group: Action Arguments
--content-type

Content type of message.

Property Value
Parameter group: Correlation Filter Arguments
--correlation-filter --correlation-filter-property

Dictionary object for custom filters.

Property Value
Parameter group: Correlation Filter Arguments
--correlation-id

Identifier of correlation.

Property Value
Parameter group: Correlation Filter Arguments
--enable-action-preprocessing

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

Property Value
Parameter group: Action Arguments
Accepted values: false, true
--enable-correlation-preprocessing

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

Property Value
Parameter group: Correlation Filter Arguments
Accepted values: false, true
--enable-sql-preprocessing

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

Property Value
Parameter group: SQL Filter Arguments
Accepted values: false, true
--filter-sql-expression

SQL expression. e.g. myproperty=test.

Property Value
Parameter group: SQL Filter Arguments
--filter-type

Rule Filter types.

Property Value
Parameter group: Action Arguments
Accepted values: CorrelationFilter, SqlFilter
--label

Application specific label.

Property Value
Parameter group: Correlation Filter Arguments
--message-id

Identifier of message.

Property Value
Parameter group: Correlation Filter Arguments
--no-wait

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

Property Value
Default value: False
--reply-to

Address of the queue to reply to.

Property Value
Parameter group: Correlation Filter Arguments
--reply-to-session-id

Session identifier to reply to.

Property Value
Parameter group: Correlation Filter Arguments
--session-id

Session identifier.

Property Value
Parameter group: Correlation Filter Arguments
--to

Address to send to.

Property Value
Parameter group: Correlation Filter 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.

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

Edit

Delete an existing rule.

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

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

The rule name.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

The namespace name.

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

The subscription name.

Property Value
Parameter group: Resource Id Arguments
--topic-name

The topic name.

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

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

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

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

Edit

Get the description for the specified rule.

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

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

The rule name.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

The namespace name.

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

The subscription name.

Property Value
Parameter group: Resource Id Arguments
--topic-name

The topic name.

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 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 --enable-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 --requires-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 --sql-expression]
                                             [--filter-type {CorrelationFilter, SqlFilter}]
                                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--ids]
                                             [--label]
                                             [--message-id]
                                             [--name --rule-name]
                                             [--namespace-name]
                                             [--properties]
                                             [--remove]
                                             [--reply-to]
                                             [--reply-to-session-id]
                                             [--resource-group]
                                             [--session-id]
                                             [--set]
                                             [--subscription]
                                             [--subscription-name]
                                             [--to]
                                             [--topic-name]

Optional Parameters

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

--action-compatibility-level

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

Property Value
Parameter group: Action Arguments
--action-preprocessing --enable-action-preprocessing

Value that indicates whether the rule action requires preprocessing.

Property Value
Parameter group: Action Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--action-sql-expression

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

Property Value
Parameter group: Action Arguments
--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>.

Property Value
Parameter group: Generic Update Arguments
--compatibility-level

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

Property Value
Parameter group: SqlFilter Arguments
--content-type

Content type of the message.

Property Value
Parameter group: CorrelationFilter Arguments
--correlation-id

Identifier of the correlation.

Property Value
Parameter group: CorrelationFilter Arguments
--enable-correlation-preprocessing --requires-preprocessing

Value that indicates whether the rule action requires preprocessing.

Property Value
Parameter group: CorrelationFilter Arguments
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.

Property Value
Parameter group: SqlFilter Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--filter-sql-expression --sql-expression

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

Property Value
Parameter group: SqlFilter Arguments
--filter-type

Filter type that is evaluated against a BrokeredMessage.

Property Value
Parameter group: Properties Arguments
Accepted values: CorrelationFilter, SqlFilter
--force-string

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

Property Value
Parameter group: Generic Update Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--label

Application specific label.

Property Value
Parameter group: CorrelationFilter Arguments
--message-id

Identifier of the message.

Property Value
Parameter group: CorrelationFilter Arguments
--name --rule-name -n

The rule name.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

The namespace name.

Property Value
Parameter group: Resource Id Arguments
--properties

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

Property Value
Parameter group: CorrelationFilter Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--reply-to

Address of the queue to reply to.

Property Value
Parameter group: CorrelationFilter Arguments
--reply-to-session-id

Session identifier to reply to.

Property Value
Parameter group: CorrelationFilter 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
--session-id

Session identifier.

Property Value
Parameter group: CorrelationFilter Arguments
--set

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

Property Value
Parameter group: Generic Update 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
--subscription-name

The subscription name.

Property Value
Parameter group: Resource Id Arguments
--to

Address to send to.

Property Value
Parameter group: CorrelationFilter Arguments
--topic-name

The topic name.

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