[SB] Delete batch changelog (#35625)

* beta release

* update

* update

* remove print

* update naming

* update version

* Update sdk/servicebus/azure-servicebus/azure/servicebus/_version.py

* Update sdk/servicebus/azure-servicebus/CHANGELOG.md

Author: l0lawrence

sdk/servicebus/azure-servicebus/CHANGELOG.md

@@ -1,19 +1,13 @@
 # Release History
 
-## 7.12.3 (Unreleased)
+## 7.13.0b1 (2024-05-16)
 
 ### Features Added
 
 - `ServiceBusReceiver` now supports the ability to delete all messages from an entity using the `purge_messages` method.  Callers may optionally request to limit the target messages to those earlier than a given date.
 
 - `ServiceBusReceiver` now supports the ability to delete messages from an entity in batches using the `delete_messages` method.  The messages selected for deletion will be the oldest in the entity, based on the enqueued date and callers may optionally request to limit them to only those earlier than a given date.
 
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
-
 ## 7.12.2 (2024-05-08)
 
 ### Bugs Fixed

sdk/servicebus/azure-servicebus/azure/servicebus/_servicebus_receiver.py

@@ -860,15 +860,15 @@ def delete_messages(
         self,
         *,
         max_message_count: Optional[int] = None,
-        before_enqueued_time_utc: Optional[datetime.datetime] = None,
+        before: Optional[datetime.datetime] = None,
         timeout: Optional[float] = None,
     ) -> int:
         """
         This operation deletes messages in the queue that are older than the specified enqueued time.
 
         :keyword int or None max_message_count: The maximum number of messages to delete. The default value is None,
          meaning it will attempt to delete up to 4,000 messages.
-        :keyword datetime.datetime or None before_enqueued_time_utc: The UTC datetime value before which all messages
+        :keyword datetime.datetime or None before: The UTC datetime value before which all messages
          should be deleted. The default value is None, meaning all messages in the queue will be considered.
         :keyword Optional[float] timeout: The total operation timeout in seconds including all the retries.
          The value must be greater than 0 if specified. The default value is None, meaning no timeout.
@@ -884,7 +884,7 @@ def delete_messages(
         message_count = max_message_count if max_message_count else 4000
 
         message_send = {
-            MGMT_REQUEST_ENQUEUED_TIME_UTC: before_enqueued_time_utc if before_enqueued_time_utc
+            MGMT_REQUEST_ENQUEUED_TIME_UTC: before if before
                 else datetime.datetime.now(datetime.timezone.utc),
             MGMT_REQUEST_MAX_MESSAGE_COUNT: message_count,
         }
@@ -902,13 +902,13 @@ def delete_messages(
     def purge_messages(
         self,
         *,
-        before_enqueued_time_utc: Optional[datetime.datetime] = None,
+        before: Optional[datetime.datetime] = None,
         timeout: Optional[float] = None,
     ) -> int:
         """
         This operation purges as many messages as possible in the queue that are older than the specified enqueued time.
 
-        :keyword datetime.datetime or None before_enqueued_time_utc: The UTC datetime value before which all messages
+        :keyword datetime.datetime or None before: The UTC datetime value before which all messages
          should be deleted. The default value is None, meaning all messages from the current time and before
          in the queue will be considered.
         :keyword Optional[float] timeout: The total operation timeout in seconds including all the retries.
@@ -923,7 +923,7 @@ def purge_messages(
         self._open()
 
         message_send = {
-            MGMT_REQUEST_ENQUEUED_TIME_UTC: before_enqueued_time_utc if before_enqueued_time_utc
+            MGMT_REQUEST_ENQUEUED_TIME_UTC: before if before
                 else datetime.datetime.now(datetime.timezone.utc),
             MGMT_REQUEST_MAX_MESSAGE_COUNT: 4000,
         }

sdk/servicebus/azure-servicebus/azure/servicebus/_version.py

@@ -3,4 +3,4 @@
 # Licensed under the MIT License.
 # ------------------------------------
 
-VERSION = "7.12.3"
+VERSION = "7.13.0b1"

sdk/servicebus/azure-servicebus/azure/servicebus/aio/_servicebus_receiver_async.py

@@ -833,15 +833,15 @@ async def delete_messages(
         self,
         *,
         max_message_count: Optional[int] = None,
-        before_enqueued_time_utc: Optional[datetime.datetime] = None,
+        before: Optional[datetime.datetime] = None,
         timeout: Optional[float] = None,
     ) -> int:
         """
         This operation deletes messages in the queue that are older than the specified enqueued time.
 
         :keyword int or None max_message_count: The maximum number of messages to delete. The default value is None,
          meaning it will attempt to delete up to 4,000 messages.
-        :keyword datetime.datetime or None before_enqueued_time_utc: The UTC datetime value before which all messages
+        :keyword datetime.datetime or None before: The UTC datetime value before which all messages
          should be deleted. The default value is None, meaning all messages in the queue will be considered.
         :keyword Optional[float] timeout: The total operation timeout in seconds including all the retries.
          The value must be greater than 0 if specified. The default value is None, meaning no timeout.
@@ -857,7 +857,7 @@ async def delete_messages(
         message_count = max_message_count if max_message_count else 4000
 
         message_send = {
-            MGMT_REQUEST_ENQUEUED_TIME_UTC: before_enqueued_time_utc if before_enqueued_time_utc
+            MGMT_REQUEST_ENQUEUED_TIME_UTC: before if before
                 else datetime.datetime.now(datetime.timezone.utc),
             MGMT_REQUEST_MAX_MESSAGE_COUNT: message_count,
         }
@@ -878,13 +878,13 @@ async def delete_messages(
     async def purge_messages(
         self,
         *,
-        before_enqueued_time_utc: Optional[datetime.datetime] = None,
+        before: Optional[datetime.datetime] = None,
         timeout: Optional[float] = None,
     ) -> int:
         """
         This operation purges as many messages as possible in the queue that are older than the specified enqueued time.
 
-        :keyword datetime.datetime or None before_enqueued_time_utc: The UTC datetime value before which all messages
+        :keyword datetime.datetime or None before: The UTC datetime value before which all messages
          should be deleted. The default value is None, meaning all messages from the current time and before
          in the queue will be considered.
         :keyword Optional[float] timeout: The total operation timeout in seconds including all the retries.
@@ -899,7 +899,7 @@ async def purge_messages(
         await self._open()
 
         message_send = {
-            MGMT_REQUEST_ENQUEUED_TIME_UTC: before_enqueued_time_utc if before_enqueued_time_utc
+            MGMT_REQUEST_ENQUEUED_TIME_UTC: before if before
                 else datetime.datetime.now(datetime.timezone.utc),
             MGMT_REQUEST_MAX_MESSAGE_COUNT: 4000,
         }

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

@@ -43,7 +43,7 @@ async def run():
             print(f"Deleting messages that are older than {new_time}")
             deleted_msgs = await receiver.delete_messages(
                 max_message_count=10,
-                before_enqueued_time_utc=new_time
+                before=new_time
             )
             print(f"{deleted_msgs} messages deleted.")
 

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

@@ -61,7 +61,7 @@ async def main():
                 topic_name=TOPIC_NAME,
                 subscription_name='sb-allmsgs-sub'
             )
-        print("sent")
+
         async with receiver:
             deleted_msgs = await receiver.purge_messages()
             print(deleted_msgs)

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

@@ -40,7 +40,7 @@ def send_single_message(sender, i):
         print(f"Deleting messages that are older than {new_time}")
         deleted_msgs = receiver.delete_messages(
             max_message_count=10,
-            before_enqueued_time_utc=new_time
+            before=new_time
         )
         print(f"{deleted_msgs} messages deleted.")
 

sdk/servicebus/azure-servicebus/tests/async_tests/test_queues_async.py

@@ -2860,7 +2860,7 @@ async def test_message_deleted_async(self, uamqp_transport, *, servicebus_namesp
             receiver = sb_client.get_queue_receiver(servicebus_queue.name, receive_mode=ServiceBusReceiveMode.RECEIVE_AND_DELETE)
             number_deleted_messages = 0
             async with receiver:
-                number_deleted_messages = await receiver.delete_messages(max_message_count=10, before_enqueued_time_utc=datetime.utcnow())
+                number_deleted_messages = await receiver.delete_messages(max_message_count=10, before=datetime.utcnow())
             assert number_deleted_messages == 10
 
             receiver_peek = sb_client.get_queue_receiver(servicebus_queue.name)
@@ -2898,7 +2898,7 @@ async def test_message_deleted_maximum_async(self, uamqp_transport, *, servicebu
             receiver = sb_client.get_queue_receiver(servicebus_queue.name)
             number_deleted_messages = 0
             async with receiver:
-                number_deleted_messages = await receiver.delete_messages(max_message_count=4000, before_enqueued_time_utc=datetime.utcnow())
+                number_deleted_messages = await receiver.delete_messages(max_message_count=4000, before=datetime.utcnow())
             assert number_deleted_messages == 4000
 
     @pytest.mark.asyncio

sdk/servicebus/azure-servicebus/tests/test_queues.py

@@ -3285,7 +3285,7 @@ def test_message_deleted(self, uamqp_transport, *, servicebus_namespace_connecti
             receiver = sb_client.get_queue_receiver(servicebus_queue.name, receive_mode=ServiceBusReceiveMode.RECEIVE_AND_DELETE)
             number_deleted_messages = 0
             with receiver:
-                number_deleted_messages = receiver.delete_messages(max_message_count=10, before_enqueued_time_utc=datetime.utcnow())
+                number_deleted_messages = receiver.delete_messages(max_message_count=10, before=datetime.utcnow())
             assert number_deleted_messages == 10
 
             receiver_peek = sb_client.get_queue_receiver(servicebus_queue.name)
@@ -3322,7 +3322,7 @@ def test_message_deleted_maximum(self, uamqp_transport, *, servicebus_namespace_
             receiver = sb_client.get_queue_receiver(servicebus_queue.name)
             number_deleted_messages = 0
             with receiver:
-                number_deleted_messages = receiver.delete_messages(max_message_count=4000, before_enqueued_time_utc=datetime.utcnow())
+                number_deleted_messages = receiver.delete_messages(max_message_count=4000, before=datetime.utcnow())
             assert number_deleted_messages == 4000
 
     @pytest.mark.liveTest