Azure Service Bus client library for .NET

Please be aware that a newer package, Azure.Messaging.ServiceBus is available as of November 2020. While this package will continue to receive critical bug fixes, we strongly encourage upgrading for new development. Please see the migration guide for more details.

Azure Service Bus allows you to build applications that take advantage of asynchronous messaging patterns using a highly-reliable service to broker messages between producers and consumers. Azure Service Bus provides flexible, brokered messaging between client and server, along with structured first-in, first-out (FIFO) messaging, and publish/subscribe capabilities with complex routing.

This directory contains the open source subset of the .NET SDK. For documentation of the complete Azure SDK, please see the Microsoft Azure .NET Developer Center.

Use the client library for Azure Service Bus to:

• Transfer business data: leverage messaging for durable exchange of information, such as sales or purchase orders, journals, or inventory movements.

• Decouple applications: improve reliability and scalability of applications and services, relieving senders and receivers of the need to be online at the same time.

• Control how messages are processed: support traditional competing consumers for messages using queues or allow each consumer their own instance of a message using topics and subscriptions.

• Implement complex workflows: message sessions support scenarios that require message ordering or message deferral.

Source code | Package (NuGet) | API reference documentation | Product documentation

Getting started

The complete Microsoft Azure SDK can be downloaded from the Microsoft Azure Downloads Page and ships with support for building deployment packages, integrating with tooling, rich command line tooling, and more.

If you are not already familiar with Azure Service Bus, please review: What is Azure Service Bus.

For the best development experience, developers should use the official Microsoft NuGet packages for libraries. NuGet packages are regularly updated with new functionality and hotfixes.

Prerequisites

• Microsoft Azure Subscription: To call Microsoft Azure services, including Azure Service Bus, you need to first create an account. If you do not have an existing Azure account, you may sign up for a free trial or use your MSDN subscriber benefits.

• The Azure Service Bus client library shares the same Prerequisites as the Microsoft Azure SDK for .NET.

Samples

Code samples for the Azure Service Bus client library that detail how to get started and how to implement common scenarios can be found in the following locations:

• Azure Code Samples
• Azure Service Bus Sample Repository
• Azure Service Bus Documentation

To build

For information on building the Azure Service bus client library, please see Building the Microsoft Azure SDK for .NET

Running tests

1. Deploy the Azure Resource Manager template located at sdk/servicebus/Microsoft.Azure.ServiceBus/assets/azure-deploy-test-dependencies.json by clicking the following button:

   

   Running the above template will provision a standard Service Bus namespace along with the required entities to successfully run the unit tests.

2. Add an Environment Variable named SERVICE_BUS_CONNECTION_STRING and set the value as the connection string of the newly created namespace. Please note that if you are using Visual Studio, you must restart Visual Studio in order to use new Environment Variables.

Once you have completed the above, you can run dotnet test from the /sdk/servicebus/Microsoft.Azure.ServiceBus/tests directory.

Development history

For additional insight and context, the development, release, and issue history for the Azure Service Bus client library will continue to be available in read-only form, located in the stand-alone Azure Service Bus .NET repository.

Versioning information

The Azure Service Bus client library uses the semantic versioning scheme.

Target frameworks

For information about the target frameworks of the Azure Service Bus client library, please refer to the Target Frameworks of the Microsoft Azure SDK for .NET.

Contributing

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Additional documentation

• Azure Service Bus General Documentation
• Azure Service Bus REST API Reference
• Azure Service Bus SDK for .NET Documentation