diff --git a/sdk/servicebus/azure-servicebus/README.md b/sdk/servicebus/azure-servicebus/README.md index c25374a1f434..ad6820262ac7 100644 --- a/sdk/servicebus/azure-servicebus/README.md +++ b/sdk/servicebus/azure-servicebus/README.md @@ -210,6 +210,11 @@ with ServiceBusClient.from_connection_string(connstr) as client: msg.defer() ``` +Other settlement methods (beyond complete and defer) include: +* `dead_letter`, removing the message from the primary queue and sending it to a +special "dead-letter sub-queue" where it can be accessed using the `get_queue_deadletter_receiver` function. +* `abandon`, immediately returning the message back to the queue to be picked up by another (or the same) receiver. + ## Troubleshooting ### Logging @@ -269,14 +274,14 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio [azure_cli]: https://docs.microsoft.com/cli/azure -[api_docs]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b2/index.html +[api_docs]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b3/index.html [product_docs]: https://docs.microsoft.com/azure/service-bus-messaging/ [azure_portal]: https://portal.azure.com [azure_sub]: https://azure.microsoft.com/free/ [cloud_shell]: https://docs.microsoft.com/azure/cloud-shell/overview [cloud_shell_bash]: https://shell.azure.com/bash [pip]: https://pypi.org/project/pip/ -[pypi]: https://pypi.org/project/azure-servicebus/7.0.0b2/ +[pypi]: https://pypi.org/project/azure-servicebus/7.0.0b3/ [python]: https://www.python.org/downloads/ [venv]: https://docs.python.org/3/library/venv.html [virtualenv]: https://virtualenv.pypa.io @@ -294,10 +299,10 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio [servicebus_aad_authentication]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-authentication-and-authorization [token_credential_interface]: ../../core/azure-core/azure/core/credentials.py [pypi_azure_identity]: https://pypi.org/project/azure-identity/ -[0_50_source]: https://github.com/Azure/azure-sdk-for-python/tree/servicebus_v0.50.2/sdk/servicebus/azure-servicebus/ +[0_50_source]: https://github.com/Azure/azure-sdk-for-python/tree/servicebus_v0.50.3/sdk/servicebus/azure-servicebus/ [0_50_pypi]: https://pypi.org/project/azure-servicebus/ -[0_50_api_docs]:https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/0.50.2/index.html +[0_50_api_docs]:https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/0.50.3/index.html [0_50_product_docs]: https://docs.microsoft.com/azure/service-bus-messaging/ -[0_50_samples]: https://github.com/Azure/azure-sdk-for-python/tree/servicebus_v0.50.2/sdk/servicebus/azure-servicebus/samples -[0_50_changelog]: https://github.com/Azure/azure-sdk-for-python/blob/servicebus_v0.50.2/sdk/servicebus/azure-servicebus/CHANGELOG.md +[0_50_samples]: https://github.com/Azure/azure-sdk-for-python/tree/servicebus_v0.50.3/sdk/servicebus/azure-servicebus/samples +[0_50_changelog]: https://github.com/Azure/azure-sdk-for-python/blob/servicebus_v0.50.3/sdk/servicebus/azure-servicebus/CHANGELOG.md [migration_guide]: ./migration_guide.md diff --git a/sdk/servicebus/azure-servicebus/migration_guide.md b/sdk/servicebus/azure-servicebus/migration_guide.md index 1885ffc9ebd6..1715af743099 100644 --- a/sdk/servicebus/azure-servicebus/migration_guide.md +++ b/sdk/servicebus/azure-servicebus/migration_guide.md @@ -14,12 +14,12 @@ Note: The large version gap is in order to normalize service bus SDK versions ac ### Specific clients for sending and receiving In v7 we've simplified the API surface, making two distinct clients, rather than one for each of queue, topic, and subscription: -* `ServiceBusSender` for sending messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b2/azure.servicebus.html#azure.servicebus.ServiceBusSender) -and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b2/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSender) -* `ServiceBusReceiver` for receiving messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b2/azure.servicebus.html#azure.servicebus.ServiceBusReceiver) -and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b2/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusReceiver) -* `ServiceBusSessionReceiver` for receiving messages from a session. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b2/azure.servicebus.html#azure.servicebus.ServiceBusSessionReceiver) -and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b2/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSessionReceiver) +* `ServiceBusSender` for sending messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b3/azure.servicebus.html#azure.servicebus.ServiceBusSender) +and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b3/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSender) +* `ServiceBusReceiver` for receiving messages. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b3/azure.servicebus.html#azure.servicebus.ServiceBusReceiver) +and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b3/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusReceiver) +* `ServiceBusSessionReceiver` for receiving messages from a session. [Sync API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b3/azure.servicebus.html#azure.servicebus.ServiceBusSessionReceiver) +and [Async API](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b3/azure.servicebus.aio.html#azure.servicebus.aio.ServiceBusSessionReceiver) As a user this will be largely transparent to you, as initialization will still occur primarily via the top level ServiceBusClient, the primary difference will be that rather than creating a queue_client, for instance, and then a sender off of that, you would simply diff --git a/sdk/servicebus/azure-servicebus/samples/README.md b/sdk/servicebus/azure-servicebus/samples/README.md index da7be8a12abb..382d9646a82f 100644 --- a/sdk/servicebus/azure-servicebus/samples/README.md +++ b/sdk/servicebus/azure-servicebus/samples/README.md @@ -11,7 +11,7 @@ urlFragment: servicebus-samples # Azure Service Bus client library for Python Samples > **NOTE**: This document outlines the samples for the **preview** of the next version of the `azure-servicebus` package -> which has different APIs than the current version (0.50). Please visit [this link](https://github.com/Azure/azure-sdk-for-python/tree/servicebus_v0.50.2/sdk/servicebus/azure-servicebus/samples) for samples of the existing library. +> which has different APIs than the current version (0.50). Please visit [this link](https://github.com/Azure/azure-sdk-for-python/tree/servicebus_v0.50.3/sdk/servicebus/azure-servicebus/samples) for samples of the existing library. These are code samples that show common scenario operations with the Azure Service Bus client library. Both [sync version](./sync_samples) and [async version](./async_samples) of samples are provided, async samples require Python 3.5 or later. @@ -76,5 +76,5 @@ pip install --pre azure-servicebus ## Next steps -Check out the [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b2/index.html) to learn more about +Check out the [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/7.0.0b3/index.html) to learn more about what you can do with the Azure Service Bus client library.