1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
"""
Examples to show basic use case of python azure-servicebus SDK, including:
- Create ServiceBusClient
- Create ServiceBusSender/ServiceBusReceiver
- Send single message and batch messages
- Peek, receive and settle messages
- Receive and settle dead-lettered messages
- Receive and settle deferred messages
- Schedule and cancel scheduled messages
- Session related operations
"""
import os
import datetime
from azure.servicebus import ServiceBusClient, ServiceBusMessage
def process_message(message):
print(str(message))
def example_create_servicebus_client_sync():
# [START create_sb_client_from_conn_str_sync]
import os
from azure.servicebus import ServiceBusClient
servicebus_connection_str = os.environ["SERVICEBUS_CONNECTION_STR"]
servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)
# [END create_sb_client_from_conn_str_sync]
# [START create_sb_client_sync]
import os
from azure.identity import DefaultAzureCredential
from azure.servicebus import ServiceBusClient
fully_qualified_namespace = os.environ["SERVICEBUS_FULLY_QUALIFIED_NAMESPACE"]
servicebus_client = ServiceBusClient(
fully_qualified_namespace=fully_qualified_namespace, credential=DefaultAzureCredential()
)
# [END create_sb_client_sync]
return servicebus_client
def example_create_servicebus_sender_sync():
servicebus_client = example_create_servicebus_client_sync()
# [START create_servicebus_sender_from_conn_str_sync]
import os
from azure.servicebus import ServiceBusSender
servicebus_connection_str = os.environ["SERVICEBUS_CONNECTION_STR"]
queue_name = os.environ["SERVICEBUS_QUEUE_NAME"]
queue_sender = ServiceBusSender._from_connection_string(conn_str=servicebus_connection_str, queue_name=queue_name)
# [END create_servicebus_sender_from_conn_str_sync]
# [START create_servicebus_sender_from_sb_client_sync]
import os
from azure.servicebus import ServiceBusClient
servicebus_connection_str = os.environ["SERVICEBUS_CONNECTION_STR"]
queue_name = os.environ["SERVICEBUS_QUEUE_NAME"]
servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)
with servicebus_client:
queue_sender = servicebus_client.get_queue_sender(queue_name=queue_name)
# [END create_servicebus_sender_from_sb_client_sync]
# [START create_topic_sender_from_sb_client_sync]
import os
from azure.servicebus import ServiceBusClient
servicebus_connection_str = os.environ["SERVICEBUS_CONNECTION_STR"]
topic_name = os.environ["SERVICEBUS_TOPIC_NAME"]
servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)
with servicebus_client:
topic_sender = servicebus_client.get_topic_sender(topic_name=topic_name)
# [END create_topic_sender_from_sb_client_sync]
queue_sender = servicebus_client.get_queue_sender(queue_name=queue_name)
return queue_sender
def example_create_servicebus_receiver_sync():
servicebus_client = example_create_servicebus_client_sync()
# [START create_servicebus_receiver_from_conn_str_sync]
import os
from azure.servicebus import ServiceBusReceiver
servicebus_connection_str = os.environ["SERVICEBUS_CONNECTION_STR"]
queue_name = os.environ["SERVICEBUS_QUEUE_NAME"]
queue_receiver = ServiceBusReceiver._from_connection_string(
conn_str=servicebus_connection_str, queue_name=queue_name
)
# [END create_servicebus_receiver_from_conn_str_sync]
# [START create_queue_deadletter_receiver_from_sb_client_sync]
import os
from azure.servicebus import ServiceBusClient, ServiceBusSubQueue
servicebus_connection_str = os.environ["SERVICEBUS_CONNECTION_STR"]
queue_name = os.environ["SERVICEBUS_QUEUE_NAME"]
servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)
with servicebus_client:
queue_dlq_receiver = servicebus_client.get_queue_receiver(
queue_name=queue_name, sub_queue=ServiceBusSubQueue.DEAD_LETTER
)
# [END create_queue_deadletter_receiver_from_sb_client_sync]
# [START create_servicebus_receiver_from_sb_client_sync]
import os
from azure.servicebus import ServiceBusClient
servicebus_connection_str = os.environ["SERVICEBUS_CONNECTION_STR"]
queue_name = os.environ["SERVICEBUS_QUEUE_NAME"]
servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)
with servicebus_client:
queue_receiver = servicebus_client.get_queue_receiver(queue_name=queue_name)
# [END create_servicebus_receiver_from_sb_client_sync]
# [START create_subscription_receiver_from_sb_client_sync]
import os
from azure.servicebus import ServiceBusClient
servicebus_connection_str = os.environ["SERVICEBUS_CONNECTION_STR"]
topic_name = os.environ["SERVICEBUS_TOPIC_NAME"]
subscription_name = os.environ["SERVICEBUS_SUBSCRIPTION_NAME"]
servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)
with servicebus_client:
subscription_receiver = servicebus_client.get_subscription_receiver(
topic_name=topic_name,
subscription_name=subscription_name,
)
# [END create_subscription_receiver_from_sb_client_sync]
# [START create_subscription_deadletter_receiver_from_sb_client_sync]
import os
from azure.servicebus import ServiceBusClient, ServiceBusSubQueue
servicebus_connection_str = os.environ["SERVICEBUS_CONNECTION_STR"]
topic_name = os.environ["SERVICEBUS_TOPIC_NAME"]
subscription_name = os.environ["SERVICEBUS_SUBSCRIPTION_NAME"]
servicebus_client = ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str)
with servicebus_client:
subscription_dlq_receiver = servicebus_client.get_subscription_receiver(
topic_name=topic_name, subscription_name=subscription_name, sub_queue=ServiceBusSubQueue.DEAD_LETTER
)
# [END create_subscription_deadletter_receiver_from_sb_client_sync]
queue_receiver = servicebus_client.get_queue_receiver(queue_name=queue_name)
return queue_receiver
def example_send_and_receive_sync():
from azure.servicebus import ServiceBusMessage
servicebus_sender = example_create_servicebus_sender_sync()
# [START send_sync]
with servicebus_sender:
message_send = ServiceBusMessage("Hello World")
servicebus_sender.send_messages(message_send)
# [END send_sync]
servicebus_sender.send_messages([ServiceBusMessage("Hello World")] * 5)
servicebus_sender = example_create_servicebus_sender_sync()
# [START create_batch_sync]
with servicebus_sender:
batch_message = servicebus_sender.create_message_batch()
batch_message.add_message(ServiceBusMessage("Single message inside batch"))
# [END create_batch_sync]
# [START send_complex_message]
message_send = ServiceBusMessage(
"Hello World!!",
session_id="MySessionID",
application_properties={"data": "custom_data"},
time_to_live=datetime.timedelta(seconds=30),
label="MyLabel",
)
# [END send_complex_message]
servicebus_receiver = example_create_servicebus_receiver_sync()
# [START peek_messages_sync]
with servicebus_receiver:
messages_peek = servicebus_receiver.peek_messages()
for message in messages_peek:
print(str(message))
# [END peek_messages_sync]
servicebus_receiver = example_create_servicebus_receiver_sync()
# [START auto_lock_renew_message_sync]
from azure.servicebus import AutoLockRenewer
lock_renewal = AutoLockRenewer(max_workers=4)
with servicebus_receiver:
for message in servicebus_receiver:
# Auto renew message for 1 minute.
lock_renewal.register(servicebus_receiver, message, max_lock_renewal_duration=60)
process_message(message)
servicebus_receiver.complete_message(message)
# [END auto_lock_renew_message_sync]
break
servicebus_receiver = example_create_servicebus_receiver_sync()
# [START receive_sync]
with servicebus_receiver:
messages_sync = servicebus_receiver.receive_messages(max_wait_time=5)
for message in messages_sync:
print(str(message))
servicebus_receiver.complete_message(message)
# [END receive_sync]
# [START receive_complex_message]
from typing import List
from azure.servicebus import ServiceBusReceivedMessage
messages_complex: List[ServiceBusReceivedMessage] = servicebus_receiver.receive_messages(max_wait_time=5)
for message in messages_complex:
print("Receiving: {}".format(message))
print("Time to live: {}".format(message.time_to_live))
print("Sequence number: {}".format(message.sequence_number))
print("Enqueued Sequence number: {}".format(message.enqueued_sequence_number))
print("Partition Key: {}".format(message.partition_key))
print("Application Properties: {}".format(message.application_properties))
print("Delivery count: {}".format(message.delivery_count))
print("Message ID: {}".format(message.message_id))
print("Locked until: {}".format(message.locked_until_utc))
print("Lock Token: {}".format(message.lock_token))
print("Enqueued time: {}".format(message.enqueued_time_utc))
# [END receive_complex_message]
# [START abandon_message_sync]
messages_abandon = servicebus_receiver.receive_messages(max_wait_time=5)
for message in messages_abandon:
servicebus_receiver.abandon_message(message)
# [END abandon_message_sync]
# [START complete_message_sync]
messages_complete = servicebus_receiver.receive_messages(max_wait_time=5)
for message in messages_complete:
servicebus_receiver.complete_message(message)
# [END complete_message_sync]
# [START defer_message_sync]
messages_defer = servicebus_receiver.receive_messages(max_wait_time=5)
for message in messages_defer:
servicebus_receiver.defer_message(message)
# [END defer_message_sync]
# [START dead_letter_message_sync]
messages_dead_letter = servicebus_receiver.receive_messages(max_wait_time=5)
for message in messages_dead_letter:
servicebus_receiver.dead_letter_message(message)
# [END dead_letter_message_sync]
# [START renew_message_lock_sync]
messages_lock = servicebus_receiver.receive_messages(max_wait_time=5)
for message in messages_lock:
servicebus_receiver.renew_message_lock(message)
# [END renew_message_lock_sync]
servicebus_receiver = example_create_servicebus_receiver_sync()
# [START receive_forever]
with servicebus_receiver:
for message in servicebus_receiver:
print(str(message))
servicebus_receiver.complete_message(message)
# [END receive_forever]
break
def example_receive_deferred_sync():
servicebus_sender = example_create_servicebus_sender_sync()
servicebus_receiver = example_create_servicebus_receiver_sync()
with servicebus_sender:
servicebus_sender.send_messages(ServiceBusMessage("Hello World"))
# [START receive_defer_sync]
with servicebus_receiver:
deferred_sequenced_numbers = []
messages_defer = servicebus_receiver.receive_messages(max_wait_time=5)
for message in messages_defer:
deferred_sequenced_numbers.append(message.sequence_number)
print(str(message))
servicebus_receiver.defer_message(message)
received_deferred_msg = servicebus_receiver.receive_deferred_messages(
sequence_numbers=deferred_sequenced_numbers
)
for msg in received_deferred_msg:
servicebus_receiver.complete_message(msg)
# [END receive_defer_sync]
def example_receive_deadletter_sync():
from azure.servicebus import ServiceBusSubQueue
servicebus_connection_str = os.environ["SERVICEBUS_CONNECTION_STR"]
queue_name = os.environ["SERVICEBUS_QUEUE_NAME"]
with ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str) as servicebus_client:
with servicebus_client.get_queue_sender(queue_name) as servicebus_sender:
servicebus_sender.send_messages(ServiceBusMessage("Hello World"))
# [START receive_deadletter_sync]
with servicebus_client.get_queue_receiver(queue_name) as servicebus_receiver:
messages = servicebus_receiver.receive_messages(max_wait_time=5)
for message in messages:
servicebus_receiver.dead_letter_message(
message, reason="reason for dead lettering", error_description="description for dead lettering"
)
with servicebus_client.get_queue_receiver(
queue_name, sub_queue=ServiceBusSubQueue.DEAD_LETTER
) as servicebus_deadletter_receiver:
messages_deadletter = servicebus_deadletter_receiver.receive_messages(max_wait_time=5)
for message in messages_deadletter:
servicebus_deadletter_receiver.complete_message(message)
# [END receive_deadletter_sync]
def example_session_ops_sync():
servicebus_connection_str = os.environ["SERVICEBUS_CONNECTION_STR"]
queue_name = os.environ["SERVICEBUS_SESSION_QUEUE_NAME"]
session_id = os.environ["SERVICEBUS_SESSION_ID"]
with ServiceBusClient.from_connection_string(conn_str=servicebus_connection_str) as servicebus_client:
with servicebus_client.get_queue_sender(queue_name=queue_name) as sender:
sender.send_messages(ServiceBusMessage("msg", session_id=session_id))
# [START get_session_sync]
with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id) as receiver:
session = receiver.session
# [END get_session_sync]
# [START get_session_state_sync]
with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id) as receiver:
session = receiver.session
session_state = session.get_state()
# [END get_session_state_sync]
# [START set_session_state_sync]
with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id) as receiver:
session = receiver.session
session.set_state("START")
# [END set_session_state_sync]
# [START session_renew_lock_sync]
with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id) as receiver:
session = receiver.session
session.renew_lock()
# [END session_renew_lock_sync]
# [START auto_lock_renew_session_sync]
from azure.servicebus import AutoLockRenewer
lock_renewal = AutoLockRenewer(max_workers=4)
with servicebus_client.get_queue_receiver(queue_name=queue_name, session_id=session_id) as receiver:
session = receiver.session
# Auto renew session lock for 2 minutes
lock_renewal.register(receiver, session, max_lock_renewal_duration=120)
for message in receiver:
process_message(message)
receiver.complete_message(message)
# [END auto_lock_renew_session_sync]
break
def example_schedule_ops_sync():
servicebus_sender = example_create_servicebus_sender_sync()
# [START scheduling_messages]
with servicebus_sender:
scheduled_time_utc = datetime.datetime.utcnow() + datetime.timedelta(seconds=30)
scheduled_messages = [ServiceBusMessage("Scheduled message") for _ in range(10)]
sequence_nums = servicebus_sender.schedule_messages(scheduled_messages, scheduled_time_utc)
# [END scheduling_messages]
servicebus_sender = example_create_servicebus_sender_sync()
# [START cancel_scheduled_messages]
with servicebus_sender:
servicebus_sender.cancel_scheduled_messages(sequence_nums)
# [END cancel_scheduled_messages]
example_send_and_receive_sync()
example_receive_deferred_sync()
example_schedule_ops_sync()
example_receive_deadletter_sync()
example_session_ops_sync()
|