Blog Post

Messaging on Azure Blog
3 MIN READ

Steps to upgrade control plane API references for Azure Service Bus, Event Hubs and Relay

SurajIyer's avatar
SurajIyer
Icon for Microsoft rankMicrosoft
Sep 29, 2023

This blog describes the areas that will need inspection and further action to reference newer API versions in your application architecture. Customers who are using older control plane API versions (2014-09-01, 2015-08-01, 2016-07-01) to interact with resources need to reference to Api version (2021-11-01) or newer to experience a regionally resilient platform and make sure of newer features that were introduced into the platform.  

 

The following section describes the version upgrade instructions depending on the modes you use to interact with Azure Service Bus, Azure Event Hubs and Azure Relay resources (only control plane or management operations). 

 

If you directly reference APIs in applications 

If your application is directly referencing 2014-09-01 or 2015-08-01 or 2016-07-01APIs for control plane (ARM) operations, please update the API to the latest API as specified below  

Current API reference  

New API Reference  

2014-09-01 

2021-11-01 

2015-08-01 

2021-11-01 

2016-07-01 

2021-11-01 

 

If you use SDKs to interact with resources  

If your application uses an SDK, please update as specified below:  

Current SDK (if you are using) 

New package (upgrade to)  

Microsoft.WindowsAzure.Management.ServiceBus 

Azure.ResourceManager.ServiceBus 

Microsoft.Azure.Management.ServiceBus.Fluent 

Azure.ResourceManager.ServiceBus ( refer NuGet Gallery | Microsoft.Azure.Management.ServiceBus.Fluent 1.38.1) 

Microsoft.Azure.Management.ServiceBus 

Azure.ResourceManager.ServiceBus 

Azure.resourcemanager.ServiceBus 

No Change 

Microsoft.Azure.Management.EventHub 

Azure.ResourceManager.EventHubs 

Azure.Resourcemanager.Eventhubs 

No Change 

Microsoft.Azure.Management.EventHub.FLuent 

Azure.ResourceManager.EventHubs (NuGet Gallery | Microsoft.Azure.Management.EventHub.Fluent 1.38.1) 

Microsoft.Azure.Management.Relay 

Azure.ResourceManager.Relay 

Azure.ResourceManager.Relay 

No Change 

Microsoft.Azure.Management.Relay.Fluent 

Azure.ResourceManager.Relay (NuGet Gallery | Microsoft.Azure.Management.Relay.Fluent 1.9.1-beta) 

 

If Azure PowerShell commandlets are used to interact with resources 

If you use Azure PowerShell interface to communicate with messaging resources, please upgrade the PowerShell version to the latest release as referenced below -  

Update instructions for Azure PowerShell can be found here-  

Update-Module (PowerShellGet) - PowerShell | Microsoft Learn 


If Azure CLI (command line interface) is used to interact with resources 
 

If you use Azure Command line interface (CLI) to communicate with messaging resources, please upgrade the CLI to the latest release as referenced below -  

Update instructions for Azure CLI can be found here –  

How to update the Azure CLI | Microsoft Learn 

Updated Sep 29, 2023
Version 1.0
No CommentsBe the first to comment