Service Bus: Custom Endpoint Address Support

[jsquire]

Summary

When using an Express Route circuit, there are some configurations which are not able to open the initial connection to the Service Bus service using the fully qualified namespace as the connection endpoint. In these cases, a custom endpoint address is needed to ensure the correct routing for the connection but should only be used when first establishing the connection; after that point, the fully qualified namespace is expected by the service for normal operations.

In order to support this scenario, an approach is needed to allow for the endpoint address for connections to be overridden with an explicit value, taking precedence over the default behavior of assuming the fully qualified namespace.

Scope of Work

• Implement the design for supporting a custom endpoint address.

Success Criteria

• The design has been implemented and the targeted clients are able to provide a custom endpoint address for connecting to the Service Bus service which is respected by the client library types.

• The tests necessary for its validation have been created or adjusted and pass reliably.

• The existing test suite continues to produce deterministic results and pass reliably.

Related Issues and References

• Design Proposal for Custom Endpoint Address Support (https://gist.github.com/jsquire/f0948c9a5ffe2741b03d312dcf8d899e)
• [Pull Request] Event Hubs: support specifying a custom endpoint (#12909)

[jeremymeng]

Done in PR #21698