Microsoft.Azure.ServiceBus 5.2.0

Prefix Reserved
Suggested Alternatives

Azure.Messaging.ServiceBus

Additional Details

Please note, a newer package is available at https://nuget.org/packages/Azure.Messaging.ServiceBus as of 11/2020.
While this package will continue to receive critical bug fixes, we strongly encourage you to upgrade.
See the Migration Guide at https://aka.ms/azsdk/net/migrate/sb for more details.

dotnet add package Microsoft.Azure.ServiceBus --version 5.2.0                
NuGet\Install-Package Microsoft.Azure.ServiceBus -Version 5.2.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.Azure.ServiceBus" Version="5.2.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Azure.ServiceBus --version 5.2.0                
#r "nuget: Microsoft.Azure.ServiceBus, 5.2.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Microsoft.Azure.ServiceBus as a Cake Addin
#addin nuget:?package=Microsoft.Azure.ServiceBus&version=5.2.0

// Install Microsoft.Azure.ServiceBus as a Cake Tool
#tool nuget:?package=Microsoft.Azure.ServiceBus&version=5.2.0                

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:

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:

    <a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-sdk-for-net%2Fmaster%2Fsdk%2Fservicebus%2FMicrosoft.Azure.ServiceBus%2Fassets%2Fazure-deploy-test-dependencies.json" target="_blank"> <img src="http://azuredeploy.net/deploybutton.png"/> </a>

    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

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (302)

Showing the top 5 NuGet packages that depend on Microsoft.Azure.ServiceBus:

Package Downloads
Microsoft.Azure.WebJobs.ServiceBus

Package Description

Foundatio.AzureServiceBus

Pluggable foundation blocks for building distributed apps.

BumperLane.Tenant.Service.Client

BumperLane service client.

ServiceBus.AttachmentPlugin

Microsoft Azure ServiceBus attachment plugin

ServiceStack.Azure

ServiceStack integration for Azure Services in Azure and Windows ServiceBus, Azure Blob Storage / Virtual File System, Azure Table Storage / Cache Provider.

GitHub repositories (28)

Showing the top 5 popular GitHub repositories that depend on Microsoft.Azure.ServiceBus:

Repository Stars
ServiceStack/ServiceStack
Thoughtfully architected, obscenely fast, thoroughly enjoyable web services for all
danielgerlag/workflow-core
Lightweight workflow engine for .NET Standard
Azure/azure-functions-host
The host/runtime that powers Azure Functions
microsoft/PowerApps-Samples
Sample code for Power Apps, including Dataverse, model-driven apps, canvas apps, Power Apps component framework, portals, and AI Builder.
microsoft/coyote
Coyote is a library and tool for testing concurrent C# code and deterministically reproducing bugs.
Version Downloads Last updated
5.2.0 19,280,299 11/8/2021 5.2.0 is deprecated.
5.1.3 10,170,761 4/19/2021 5.1.3 is deprecated.
5.1.2 4,944,467 2/25/2021 5.1.2 is deprecated.
5.1.1 3,466,080 1/13/2021 5.1.1 is deprecated.
5.1.0 4,507,624 11/20/2020 5.1.0 is deprecated.
5.0.0 9,355,257 9/11/2020 5.0.0 is deprecated.
4.2.1 8,571,609 1/15/2021 4.2.1 is deprecated.
4.2.0 2,051,570 9/15/2020 4.2.0 is deprecated.
4.1.3 11,604,950 4/17/2020 4.1.3 is deprecated.
4.1.2 3,404,775 3/3/2020 4.1.2 is deprecated.
4.1.1 12,778,268 11/9/2019 4.1.1 is deprecated.
4.1.0 965,791 10/21/2019 4.1.0 is deprecated.
4.0.0 3,451,207 8/8/2019 4.0.0 is deprecated.
3.4.0 6,876,501 3/26/2019 3.4.0 is deprecated.
3.3.0 3,482,592 1/18/2019 3.3.0 is deprecated.
3.2.1 3,351,487 12/14/2018 3.2.1 is deprecated.
3.2.0 823,146 11/27/2018 3.2.0 is deprecated.
3.1.1 1,870,034 9/29/2018 3.1.1 is deprecated.
3.1.0 1,502,972 8/10/2018 3.1.0 is deprecated.
3.1.0-preview 83,566 6/28/2018 3.1.0-preview is deprecated.
3.0.2 4,556,000 5/31/2018 3.0.2 is deprecated.
3.0.1.16 118,254 5/23/2018 3.0.1.16 is deprecated.
3.0.0 445,463 5/15/2018 3.0.0 is deprecated.
3.0.0-preview-02 55,178 2/23/2018 3.0.0-preview-02 is deprecated.
3.0.0-preview-01 24,914 12/16/2017 3.0.0-preview-01 is deprecated.
2.0.0 4,112,424 10/12/2017 2.0.0 is deprecated.
1.0.0 589,912 8/11/2017 1.0.0 is deprecated.
1.0.0-RC1 4,885 8/3/2017 1.0.0-RC1 is deprecated.
0.0.7-preview 9,130 7/14/2017 0.0.7-preview is deprecated.
0.0.6-preview 13,019 6/2/2017 0.0.6-preview is deprecated.
0.0.5-preview 19,803 5/16/2017 0.0.5-preview is deprecated.
0.0.3-preview 22,792 4/13/2017 0.0.3-preview is deprecated.
0.0.2-preview 39,009 4/3/2017 0.0.2-preview is deprecated.