[ServiceBus] update samples, docs and tests for sql rule filter (Azure#18042)

Closing issue: Azure#17525

Author: yunhaoling

sdk/servicebus/azure-servicebus/azure/servicebus/management/_models.py

@@ -1062,6 +1062,20 @@ class SqlRuleFilter(object):
     """Represents a filter which is a composition of an expression and an action
     that is executed in the pub/sub pipeline.
 
+    .. admonition:: Example:
+
+        .. code-block:: python
+            :caption: Create SqlRuleFilter.
+
+            sql_filter = SqlRuleFilter("property1 = 'value'")
+            sql_filter_parametrized = SqlRuleFilter(
+                "property1 = @param1 AND property2 = @param2",
+                parameters={
+                    "@param1": "value",
+                    "@param2" : 1
+                }
+            )
+
     :param sql_expression: The SQL expression. e.g. MyProperty='ABC'
     :type sql_expression: str
     :param parameters: Sets the value of the sql expression parameters if any.

sdk/servicebus/azure-servicebus/samples/async_samples/mgmt_rule_async.py

@@ -8,6 +8,7 @@
 """
 Example to show managing rule entities under a ServiceBus Subscription, including
     - Create a rule
+    - Create a rule with sql filter
     - Get rule properties.
     - Update a rule
     - Delete a rule
@@ -19,12 +20,14 @@
 import os
 import asyncio
 import uuid
+from azure.servicebus.management import SqlRuleFilter
 from azure.servicebus.aio.management import ServiceBusAdministrationClient
 
 CONNECTION_STR = os.environ['SERVICE_BUS_CONNECTION_STR']
 TOPIC_NAME = os.environ['SERVICE_BUS_TOPIC_NAME']
 SUBSCRIPTION_NAME = os.environ['SERVICE_BUS_SUBSCRIPTION_NAME']
 RULE_NAME = "sb_mgmt_rule" + str(uuid.uuid4())
+RULE_WITH_SQL_FILTER_NAME = "sb_mgmt_sql_filter_rule" + str(uuid.uuid4())[:16]
 
 
 async def create_rule(servicebus_mgmt_client):
@@ -33,11 +36,25 @@ async def create_rule(servicebus_mgmt_client):
     print("Rule {} is created.".format(RULE_NAME))
     print("")
 
+    print("-- Create Rule with SQL Filter")
+    sql_filter_parametrized = SqlRuleFilter(
+        "property1 = @param1 AND property2 = @param2",
+        parameters={
+            "@param1": "value",
+            "@param2" : 1
+        }
+    )
+    await servicebus_mgmt_client.create_rule(TOPIC_NAME, SUBSCRIPTION_NAME, RULE_WITH_SQL_FILTER_NAME, filter=sql_filter_parametrized)
+    print("Rule {} is created.".format(RULE_WITH_SQL_FILTER_NAME))
+    print("")
+
 
 async def delete_rule(servicebus_mgmt_client):
     print("-- Delete Rule")
     await servicebus_mgmt_client.delete_rule(TOPIC_NAME, SUBSCRIPTION_NAME, RULE_NAME)
     print("Rule {} is deleted.".format(RULE_NAME))
+    await servicebus_mgmt_client.delete_rule(TOPIC_NAME, SUBSCRIPTION_NAME, RULE_WITH_SQL_FILTER_NAME)
+    print("Rule {} is deleted.".format(RULE_WITH_SQL_FILTER_NAME))
     print("")
 
 

sdk/servicebus/azure-servicebus/samples/sync_samples/mgmt_rule.py

@@ -8,6 +8,7 @@
 """
 Example to show managing rule entities under a ServiceBus Subscription, including
     - Create a rule
+    - Create a rule with sql filter
     - Get rule properties and runtime information
     - Update a rule
     - Delete a rule
@@ -18,13 +19,16 @@
 
 import os
 import uuid
-from azure.servicebus.management import ServiceBusAdministrationClient
+from azure.servicebus.management import (
+    ServiceBusAdministrationClient,
+    SqlRuleFilter
+)
 
 CONNECTION_STR = os.environ['SERVICE_BUS_CONNECTION_STR']
 TOPIC_NAME = os.environ['SERVICE_BUS_TOPIC_NAME']
 SUBSCRIPTION_NAME = os.environ['SERVICE_BUS_SUBSCRIPTION_NAME']
 RULE_NAME = "sb_mgmt_rule" + str(uuid.uuid4())
-
+RULE_WITH_SQL_FILTER_NAME = "sb_mgmt_sql_filter_rule" + str(uuid.uuid4())[:16]
 
 
 def create_rule(servicebus_mgmt_client):
@@ -33,11 +37,25 @@ def create_rule(servicebus_mgmt_client):
     print("Rule {} is created.".format(RULE_NAME))
     print("")
 
+    print("-- Create Rule with SQL Filter")
+    sql_filter_parametrized = SqlRuleFilter(
+        "property1 = @param1 AND property2 = @param2",
+        parameters={
+            "@param1": "value",
+            "@param2" : 1
+        }
+    )
+    servicebus_mgmt_client.create_rule(TOPIC_NAME, SUBSCRIPTION_NAME, RULE_WITH_SQL_FILTER_NAME, filter=sql_filter_parametrized)
+    print("Rule {} is created.".format(RULE_WITH_SQL_FILTER_NAME))
+    print("")
+
 
 def delete_rule(servicebus_mgmt_client):
     print("-- Delete Rule")
     servicebus_mgmt_client.delete_rule(TOPIC_NAME, SUBSCRIPTION_NAME, RULE_NAME)
     print("Rule {} is deleted.".format(RULE_NAME))
+    servicebus_mgmt_client.delete_rule(TOPIC_NAME, SUBSCRIPTION_NAME, RULE_WITH_SQL_FILTER_NAME)
+    print("Rule {} is deleted.".format(RULE_WITH_SQL_FILTER_NAME))
     print("")