Blog Post

Apps on Azure Blog
3 MIN READ

Announcing the Public Preview of the New Hybrid Connection Manager (HCM)

jordanselig's avatar
jordanselig
Icon for Microsoft rankMicrosoft
Apr 10, 2025

We are excited to announce the public preview of the new version of the Hybrid Connection Manager (HCM), a powerful tool designed to enhance connectivity and streamline the management of Hybrid Connections. This release marks a significant milestone in our ongoing efforts to provide robust and user-friendly solutions for managing hybrid environments with App Service.

Update May 28, 2025: The new Hybrid Connection Manager is now Generally Available. The download links shared in this post will give you the latest Generally Available version. Learn more

Key Features and Improvements

The new version of HCM introduces several enhancements aimed at improving usability, performance, and security:

  • Cross-Platform Compatibility: The new HCM is now supported on both Windows and Linux clients, allowing for seamless management of hybrid connections across different platforms, providing users with greater flexibility and control.
  • Enhanced User Interface: We have redesigned the GUI to offer a more intuitive and efficient user experience. In addition to a new and more accessible GUI, we have also introduced a CLI that includes all the functionality needed to manage connections, especially for our Linux customers who may solely use a CLI to manage their workloads.
  • Improved Visibility: The new version offers enhanced logging and connection testing, which provides greater insight into connections and simplifies debugging.

Getting Started

To get started with the new Hybrid Connection Manager, follow these steps:

  1. Requirements:
    1. Windows clients must have ports 4999-5001 available
    2. Linux clients must have port 5001 available
  2. Download and Install: The new HCM can be downloaded from the following links. Ensure you download the version that corresponds to your client. If you are new to the HCM, check out the existing documentation to learn more about the product and how to get started. If you are an existing Windows user, installing the new Windows version will automatically upgrade your existing version to the new version, and all your existing connections will be automatically ported over. There is no automated migration path from the Windows to the Linux version at this time.
    1. Windows download
      • Download the MSI package and follow the installation instructions
    2. Linux download
      • From your terminal running as administrator, follow these steps:
        sudo apt update
        
        sudo apt install tar gzip build-essential
        
        sudo wget "https://download.microsoft.com/download/HybridConnectionManager-Linux.tar.gz"
        
        sudo tar -xf HybridConnectionManager-Linux.tar.gz
        
        cd HybridConnectionManager/
        
        sudo chmod 755 setup.sh
        
        sudo ./setup.sh
      • Once that is finished, your HCM is ready to be used
      • Run `hcm help` to see the available commands
      • For interactive mode, you will need to install and login to the Azure CLI. Authentication from the HCM to Azure is done using this credential.
        • Install the Azure CLI with: `install azure cli: curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash`
        • Run `az login` and follow the prompts
      • Add your first connection by running `hcm add`
  3. Configure Your Connections: Use the GUI or the CLI to add hybrid connections to your local machine.
  4. Manage Your Connections: Use the GUI or the CLI with the `hcm list` and `hcm remove` commands to manage your hybrid connections efficiently. Detailed help texts are available for each command to assist you.

Join the Preview

We invite you to join the public preview and provide your valuable feedback. Your insights will help us refine and improve the Hybrid Connections Manager to better meet your needs.

Feedback and Support

If you encounter any issues or have suggestions, please reach out to hcmsupport@service.microsoft.com or leave a comment on this post. We are committed to ensuring a smooth and productive experience with the new HCM. Detailed documentation and guidance will be available in the coming weeks as we get closer to General Availability (GA).

Thank you for your continued support and collaboration. We look forward to hearing your thoughts and feedback on this exciting new release.

Updated Aug 28, 2025
Version 6.0

13 Comments

  • Hello jordanselig​ ,

    I've been tasked with assisting with the setup of a hybrid connection. In the process, I discovered that the connection had previously been set up by another team, but the installed version of the connector is out of date, so I am looking at upgrading it.

    The version available for download from Hybrid Connections in Azure App Service - Azure App Service | Microsoft Learn is the same as the one linked to from this article. Is this version still in Public Preview? If so, where can I download the latest GA version?

    Also, where can I find a changelog listing the previously released versions with version number, date, and major changes?

    Thanks!

    • jordanselig's avatar
      jordanselig
      Icon for Microsoft rankMicrosoft

      Hi RyanSteele-CoV​ . We GA'd this feature a little while ago. We released a service update: https://azure.microsoft.com/en-us/updates/?id=494993 but not an update to this blog. Apologies for that, I have added a note to the top of this blog with the GA notice.

      The links in this article as well as the docs will always point to the latest version, which is now GA, so both places are valid. We unfortunately don't have a public changelog for this feature, but the upgrade process to the latest version should be seamless and all connections should automatically be retained, no changes needed from your side. Please let us know if you have any questions or any trouble with the upgrade.

  • danmon's avatar
    danmon
    Copper Contributor

    Hi jordanselig​ ,
    the download link for the public preview of the new HCM is unfortunately not working. Do you have a working link you could provide?
    Thank you.

  • nagagunda's avatar
    nagagunda
    Copper Contributor

    Hi jordanselig​, Thanks for the post

    I recently read the announcement regarding the public preview of the new Hybrid Connection Manager (HCM) 

    We’ve had a Hybrid Connection setup running reliably for over five years, and I’m interested in exploring the new version.

    🔄 Upgrade Path

    Is there any official documentation or guidance available for upgrading from the existing HCM to the new version? I’d like to understand the steps involved, compatibility considerations, and any potential impact on existing connections.

    🔐 Service Bus Gateway Clarification

    I also came across a note in the updated documentation mentioning that outbound access is now required not only to https://*.servicebus.windows.net, but also to the Service Bus gateways that service the Hybrid Connection 

    • Is the Service Bus Gateway a new architectural component?
    • Could you please share a data flow diagram or architecture diagram that shows where the Service Bus Gateway fits in the overall Hybrid Connection setup?
    • Our on-prem servers currently allow outbound access to *.servicebus.windows.net. Do we need to make additional firewall changes to accommodate the new gateway endpoints?

    Any insights or documentation links would be greatly appreciated as we plan our testing and potential upgrade.

    Thanks in advance!

    • jordanselig's avatar
      jordanselig
      Icon for Microsoft rankMicrosoft

      Hi nagagunda​ 

      We're still in public preview so we haven't released official docs for the upgrade path. However, installing the latest version of the HCM will replace any existing versions and copy over all existing connections. We recommend testing this out in a dev/sandbox environment to be sure the new version meets your needs and doesn't break your existing workloads. The new version has parity with the old version, so we don't expect issues, but please reach out to hcmsupport@service.microsoft.com with any issues and we will look into them with priority.

      This is not a change, additional gateways were added once the backend was upgraded to VMSS. The docs were unfortunately not updated until recently to reflect this. Your existing firewall with *.servicebus.windows.net should continue to work and you don't need any additional changes since the "*" covers the additional endpoints as well.

      This link will have details on the service bus gateway architecture https://learn.microsoft.com/azure/azure-relay/relay-what-is-it#architecture-processing-of-incoming-relay-requests if you're interested in learning more, but for App Service, this isn't completely necessary as we've tried to abstract these internal components away from the end application of them.

  • Frankza's avatar
    Frankza
    Copper Contributor

    We are also having the exact same issue as the other users. Not able to add any connection and the discovery also does not work. We are also missing a proper documentation on this tool. logs: 2025-05-21 12:14:16.357 -04:00 [ERR] Failure while adding Hybrid Connection: Error: UserMetadata must contain an endpoint composed of a host and port. but we have those values in metadata

     

    • xingyangli's avatar
      xingyangli
      Icon for Microsoft rankMicrosoft

      Hi Frankza​, thank you for reaching out and sharing your experience. Could you please email us at mailto:hcmsupport@service.microsoft.com with some additional information so that we can investigate these issues further?

      1. The Connection String value that produced the error when submitted to the input form.
      2. The UserMetadata value for the Hybrid Connection resource that produced the error log.
      3. The Shared Access Policies defined for the Hybrid Connection Resource in the Azure Portal.

      Thank you for your patience while we investigate these issues.

       

      - Xingyang

  • alvin3's avatar
    alvin3
    Copper Contributor

    Doesn't work with the connection string generated by Hybrid Connection entity under Azure Relay.

     

    • jordanselig's avatar
      jordanselig
      Icon for Microsoft rankMicrosoft

      alvin3​ Can you please share the format of the connection string you used here? Please remove any personal info from it. 

      I will update the docs to provide more info on the connection string format and where to find it. It should look like the following. I just tested with this and was able to successfully add a connection. If we confirm this is correct for you and you still can't add, we can diagnose further.

      Endpoint=sb://<namespace>.servicebus.windows.net/;SharedAccessKeyName=defaultListener;SharedAccessKey=<key>;EntityPath=<hybrid-connection-name>

      This can be found in the Azure portal if you select your Hybrid Connection:

       

      • alvin3's avatar
        alvin3
        Copper Contributor

        Hi Jordan,

        Your colleague Xingyang has emailed me that it is a bug that is incorrectly rejecting connection strings that contain any underscore characters (_). I can confirm that would be the case based on my testing so far. You are copied in that email too.

  • s_w_jensen's avatar
    s_w_jensen
    Copper Contributor

    Mails to the address above are rejected:
    UnifiedGroupAgent; Delivery failed because the sender isn't a group member or external senders aren't permitted to send to this group.