az servicebus topic subscription rule

Manage Azure Service Bus Rule.

Commands

az servicebus topic subscription rule create

Create the ServiceBus Rule for Subscription.

az servicebus topic subscription rule delete

Deletes the ServiceBus Rule.

az servicebus topic subscription rule list

List the ServiceBus Rule by Subscription.

az servicebus topic subscription rule show

Shows ServiceBus Rule Details.

az servicebus topic subscription rule update

Updates the ServiceBus Rule for Subscription.

az servicebus topic subscription rule create

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-id]
                                             [--enable-action-preprocessing {false, true}]
                                             [--enable-correlation-preprocessing {false, true}]
                                             [--enable-sql-preprocessing {false, true}]
                                             [--filter-sql-expression]
                                             [--label]
                                             [--message-id]
                                             [--reply-to]
                                             [--reply-to-session-id]
                                             [--session-id]
                                             [--subscription]
                                             [--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-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.

--label

Application specific label.

--message-id

Identifier of message.

--reply-to

Address of the queue to reply to.

--reply-to-session-id

Session identifier to reply to.

--session-id

Session identifier.

--subscription

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

--to

Address to send to.

az servicebus topic subscription rule delete

Deletes the ServiceBus Rule.

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

Examples

Deletes the ServiceBus Rule

az servicebus topic subscription rule delete --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --subscription-name mysubscription --name myrule

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 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 or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--subscription-name

Name of Subscription.

--topic-name

Name of Topic.

az servicebus topic subscription rule list

List the ServiceBus Rule by Subscription.

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

Examples

Shows the Rule ServiceBus by Subscription.

az servicebus topic subscription rule list --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --subscription-name mysubscription

Required Parameters

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

--subscription

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

--top

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

az servicebus topic subscription rule show

Shows ServiceBus Rule Details.

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

Examples

Shows the ServiceBus Rule details.

az servicebus topic subscription rule show --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --subscription-name mysubscription --name myrule

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

--namespace-name

Name of Namespace.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

Name of Subscription.

--topic-name

Name of Topic.

az servicebus topic subscription rule update

Updates the ServiceBus Rule for Subscription.

az servicebus topic subscription rule update [--action-compatibility-level]
                                             [--action-sql-expression]
                                             [--add]
                                             [--content-type]
                                             [--correlation-id]
                                             [--enable-action-preprocessing {false, true}]
                                             [--enable-correlation-preprocessing {false, true}]
                                             [--enable-sql-preprocessing {false, true}]
                                             [--filter-sql-expression]
                                             [--force-string]
                                             [--ids]
                                             [--label]
                                             [--message-id]
                                             [--name]
                                             [--namespace-name]
                                             [--remove]
                                             [--reply-to]
                                             [--reply-to-session-id]
                                             [--resource-group]
                                             [--session-id]
                                             [--set]
                                             [--subscription]
                                             [--subscription-name]
                                             [--to]
                                             [--topic-name]

Examples

Updates Rule.

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

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.

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

--content-type

Content type of message.

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

--force-string

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

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

--name -n

Name of Rule.

--namespace-name

Name of Namespace.

--remove

Remove a property or an element from a list. Example: --remove property.list 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=.

--subscription

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

--subscription-name

Name of Subscription.

--to

Address to send to.

--topic-name

Name of Topic.