[EventHubs] Support for Custom endpoint adddress and custom certificate

[yunhaoling]

addressing issues: #16047
also see gist: https://gist.github.com/jsquire/f0948c9a5ffe2741b03d312dcf8d899e

Champion Scenarios

Connecting on a restricted network

A local hospital employs a strict set of network policies to ensure the safety of their network and the security of their patient information. As part of this strategy, all traffic is routed through a security proxy which performs a threat analysis and logging of connections.

In order to allow for trusted internal applications to embrace cloud services, a special bank of IP addresses has been reserved which passes through a secure DMZ path rather than the security proxy. In order for trusted connections to work appropriately, they must resolve to one of the reserved IP addresses using a CNAME configured in the local DNS service.

Because of these restrictions, applications are unable to perform direct connections to the Azure Event Hubs service using the standard endpoint address and require the ability to specify a custom host name to ensure they route through the proper intermediary for the connection to be made.

sample code:

# use constructor
consumer_client = EventHubConsumerClient(
        "<FULLY QUALIFIED NAMESPACE>",
        "<EVENT HUB NAME>",
        "<CONSUMER GROUP>",
        credential,
        custom_endpoint_address="sb://eventhubs.mycompany.local",
        connection_verify="path_to_cert_file"
)

# use connection string
consumer_client = EventHubConsumerClient.from_connection_string (
        "<CONNECTION STRING>",
        "<CONSUMER GROUP>",
        custom_endpoint_address="sb://eventhubs.mycompany.local",
        connection_verify="path_to_cert_file"
)

Test:

by following the steps in

• [core-amqp][event-hubs] support specifying a custom endpoint azure-sdk-for-js#12909 (comment)
• https://gist.github.com/chradek/d4d6ce32ef4c5b46bf55d6e1b979b991
  I'm able to set an Azure Applicate Gateway and verify this feature

Pending:

pending uamqp v1.2.14 release: Azure/azure-uamqp-python#202

[yunhaoling]

/azp run python - eventhub - tests

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[yunhaoling]

/azp run python - eventhub - tests

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[check-enforcer]

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run python - [service] - ci

[yunhaoling]

/check-enforcer evaluate

[yunhaoling]

/check-enforcer override

[yunhaoling]

/azp run python - eventhub - tests

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[yunhaoling]

/azp run python - eventhub - ci

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[yunhaoling]

/check-enforcer evaluate

[swathipil]

lgtm

[yunhaoling]

/check-enforcer evaluate

[yunhaoling]

/azp run python - eventhub - tests

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[yunhaoling]

/check-enforcer override