Create HttpClientTransportOptions and utilize it in Confidential Ledger

sdk/confidentialledger/Azure.Security.ConfidentialLedger/src/ConfidentialLedgerClient.cs

@@ -37,21 +37,22 @@ public ConfidentialLedgerClient(Uri ledgerUri, TokenCredential credential, Confi
                 throw new ArgumentNullException(nameof(credential));
             }
 
-            var transport = GetIdentityServerTlsCertAndTrust(ledgerUri);
-            options ??= new ConfidentialLedgerClientOptions { Transport = transport };
-            _clientDiagnostics = new ClientDiagnostics(options);
+            var transportOptions = GetIdentityServerTlsCertAndTrust(ledgerUri);
+
+            _clientDiagnostics = new ClientDiagnostics(options ??= new ConfidentialLedgerClientOptions());
             _tokenCredential = credential;
             var authPolicy = new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes);
             Pipeline = HttpPipelineBuilder.Build(
                 options,
                 new HttpPipelinePolicy[] { new LowLevelCallbackPolicy() },
                 new HttpPipelinePolicy[] { authPolicy },
-                new ResponseClassifier());
+                new ResponseClassifier(),
+                transportOptions);
             this.ledgerUri = ledgerUri;
             apiVersion = options.Version;
         }
 
-        internal HttpClientTransport GetIdentityServerTlsCertAndTrust(Uri ledgerUri)
+        internal HttpPipelineTransportOptions GetIdentityServerTlsCertAndTrust(Uri ledgerUri)
         {
             var identityClient = new ConfidentialLedgerIdentityServiceClient(new Uri("https://identity.accledger.azure.com"));
 
@@ -87,10 +88,10 @@ bool CertValidationCheck(HttpRequestMessage httpRequestMessage, X509Certificate2
                     .Any(x => x.Certificate.Thumbprint == ledgerTlsCert.Thumbprint);
                 return isCertSignedByTheTlsCert;
             }
-            return new HttpClientTransport(new HttpPipelineTransportOptions
+            return new HttpPipelineTransportOptions
             {
                 ServerCertificateCustomValidationCallback = certificate2 => CertValidationCheck(null, certificate2, certificateChain, SslPolicyErrors.None)
-            });
+            };
         }
     }
 }

sdk/core/Azure.Core/api/Azure.Core.net461.cs

@@ -691,7 +691,6 @@ public partial class HttpClientTransport : Azure.Core.Pipeline.HttpPipelineTrans
     {
         public static readonly Azure.Core.Pipeline.HttpClientTransport Shared;
         public HttpClientTransport() { }
-        public HttpClientTransport(Azure.Core.Pipeline.HttpPipelineTransportOptions? options = null) { }
         public HttpClientTransport(System.Net.Http.HttpClient client) { }
         public HttpClientTransport(System.Net.Http.HttpMessageHandler messageHandler) { }
         public sealed override Azure.Core.Request CreateRequest() { throw null; }
@@ -715,6 +714,7 @@ public static partial class HttpPipelineBuilder
     {
         public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, params Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies) { throw null; }
         public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, Azure.Core.Pipeline.HttpPipelinePolicy[] perCallPolicies, Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies, Azure.Core.ResponseClassifier responseClassifier) { throw null; }
+        public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, Azure.Core.Pipeline.HttpPipelinePolicy[] perCallPolicies, Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies, Azure.Core.ResponseClassifier responseClassifier, Azure.Core.Pipeline.HttpPipelineTransportOptions? pipelineTransportOptions = null) { throw null; }
     }
     public abstract partial class HttpPipelinePolicy
     {
@@ -735,7 +735,6 @@ public override void Process(Azure.Core.HttpMessage message, System.ReadOnlyMemo
     public abstract partial class HttpPipelineTransport
     {
         protected HttpPipelineTransport() { }
-        public static Azure.Core.Pipeline.HttpPipelineTransport Create(Azure.Core.Pipeline.HttpPipelineTransportOptions? options = null) { throw null; }
         public abstract Azure.Core.Request CreateRequest();
         public abstract void Process(Azure.Core.HttpMessage message);
         public abstract System.Threading.Tasks.ValueTask ProcessAsync(Azure.Core.HttpMessage message);

sdk/core/Azure.Core/api/Azure.Core.net5.0.cs

@@ -691,7 +691,6 @@ public partial class HttpClientTransport : Azure.Core.Pipeline.HttpPipelineTrans
     {
         public static readonly Azure.Core.Pipeline.HttpClientTransport Shared;
         public HttpClientTransport() { }
-        public HttpClientTransport(Azure.Core.Pipeline.HttpPipelineTransportOptions? options = null) { }
         public HttpClientTransport(System.Net.Http.HttpClient client) { }
         public HttpClientTransport(System.Net.Http.HttpMessageHandler messageHandler) { }
         public sealed override Azure.Core.Request CreateRequest() { throw null; }
@@ -715,6 +714,7 @@ public static partial class HttpPipelineBuilder
     {
         public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, params Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies) { throw null; }
         public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, Azure.Core.Pipeline.HttpPipelinePolicy[] perCallPolicies, Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies, Azure.Core.ResponseClassifier responseClassifier) { throw null; }
+        public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, Azure.Core.Pipeline.HttpPipelinePolicy[] perCallPolicies, Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies, Azure.Core.ResponseClassifier responseClassifier, Azure.Core.Pipeline.HttpPipelineTransportOptions? pipelineTransportOptions = null) { throw null; }
     }
     public abstract partial class HttpPipelinePolicy
     {
@@ -735,7 +735,6 @@ public override void Process(Azure.Core.HttpMessage message, System.ReadOnlyMemo
     public abstract partial class HttpPipelineTransport
     {
         protected HttpPipelineTransport() { }
-        public static Azure.Core.Pipeline.HttpPipelineTransport Create(Azure.Core.Pipeline.HttpPipelineTransportOptions? options = null) { throw null; }
         public abstract Azure.Core.Request CreateRequest();
         public abstract void Process(Azure.Core.HttpMessage message);
         public abstract System.Threading.Tasks.ValueTask ProcessAsync(Azure.Core.HttpMessage message);

sdk/core/Azure.Core/api/Azure.Core.netcoreapp2.1.cs

@@ -691,7 +691,6 @@ public partial class HttpClientTransport : Azure.Core.Pipeline.HttpPipelineTrans
     {
         public static readonly Azure.Core.Pipeline.HttpClientTransport Shared;
         public HttpClientTransport() { }
-        public HttpClientTransport(Azure.Core.Pipeline.HttpPipelineTransportOptions? options = null) { }
         public HttpClientTransport(System.Net.Http.HttpClient client) { }
         public HttpClientTransport(System.Net.Http.HttpMessageHandler messageHandler) { }
         public sealed override Azure.Core.Request CreateRequest() { throw null; }
@@ -715,6 +714,7 @@ public static partial class HttpPipelineBuilder
     {
         public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, params Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies) { throw null; }
         public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, Azure.Core.Pipeline.HttpPipelinePolicy[] perCallPolicies, Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies, Azure.Core.ResponseClassifier responseClassifier) { throw null; }
+        public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, Azure.Core.Pipeline.HttpPipelinePolicy[] perCallPolicies, Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies, Azure.Core.ResponseClassifier responseClassifier, Azure.Core.Pipeline.HttpPipelineTransportOptions? pipelineTransportOptions = null) { throw null; }
     }
     public abstract partial class HttpPipelinePolicy
     {
@@ -735,7 +735,6 @@ public override void Process(Azure.Core.HttpMessage message, System.ReadOnlyMemo
     public abstract partial class HttpPipelineTransport
     {
         protected HttpPipelineTransport() { }
-        public static Azure.Core.Pipeline.HttpPipelineTransport Create(Azure.Core.Pipeline.HttpPipelineTransportOptions? options = null) { throw null; }
         public abstract Azure.Core.Request CreateRequest();
         public abstract void Process(Azure.Core.HttpMessage message);
         public abstract System.Threading.Tasks.ValueTask ProcessAsync(Azure.Core.HttpMessage message);

sdk/core/Azure.Core/api/Azure.Core.netstandard2.0.cs

@@ -691,7 +691,6 @@ public partial class HttpClientTransport : Azure.Core.Pipeline.HttpPipelineTrans
     {
         public static readonly Azure.Core.Pipeline.HttpClientTransport Shared;
         public HttpClientTransport() { }
-        public HttpClientTransport(Azure.Core.Pipeline.HttpPipelineTransportOptions? options = null) { }
         public HttpClientTransport(System.Net.Http.HttpClient client) { }
         public HttpClientTransport(System.Net.Http.HttpMessageHandler messageHandler) { }
         public sealed override Azure.Core.Request CreateRequest() { throw null; }
@@ -715,6 +714,7 @@ public static partial class HttpPipelineBuilder
     {
         public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, params Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies) { throw null; }
         public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, Azure.Core.Pipeline.HttpPipelinePolicy[] perCallPolicies, Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies, Azure.Core.ResponseClassifier responseClassifier) { throw null; }
+        public static Azure.Core.Pipeline.HttpPipeline Build(Azure.Core.ClientOptions options, Azure.Core.Pipeline.HttpPipelinePolicy[] perCallPolicies, Azure.Core.Pipeline.HttpPipelinePolicy[] perRetryPolicies, Azure.Core.ResponseClassifier responseClassifier, Azure.Core.Pipeline.HttpPipelineTransportOptions? pipelineTransportOptions = null) { throw null; }
     }
     public abstract partial class HttpPipelinePolicy
     {
@@ -735,7 +735,6 @@ public override void Process(Azure.Core.HttpMessage message, System.ReadOnlyMemo
     public abstract partial class HttpPipelineTransport
     {
         protected HttpPipelineTransport() { }
-        public static Azure.Core.Pipeline.HttpPipelineTransport Create(Azure.Core.Pipeline.HttpPipelineTransportOptions? options = null) { throw null; }
         public abstract Azure.Core.Request CreateRequest();
         public abstract void Process(Azure.Core.HttpMessage message);
         public abstract System.Threading.Tasks.ValueTask ProcessAsync(Azure.Core.HttpMessage message);

sdk/core/Azure.Core/src/ClientOptions.cs

@@ -14,6 +14,7 @@ namespace Azure.Core
     public abstract class ClientOptions
     {
         private HttpPipelineTransport _transport;
+        internal bool IsCustomTransportSet { get; private set; }
 
         /// <summary>
         /// Gets the default set of <see cref="ClientOptions"/>. Changes to the <see cref="Default"/> options would be reflected
@@ -64,7 +65,11 @@ internal ClientOptions(ClientOptions? clientOptions)
         public HttpPipelineTransport Transport
         {
             get => _transport;
-            set => _transport = value ?? throw new ArgumentNullException(nameof(value));
+            set
+            {
+                _transport = value ?? throw new ArgumentNullException(nameof(value));
+                IsCustomTransportSet = true;
+            }
         }
 
         /// <summary>

sdk/core/Azure.Core/src/Diagnostics/AzureCoreEventSource.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System;
 using System.Diagnostics.Tracing;
 
 namespace Azure.Core.Diagnostics
@@ -10,26 +11,27 @@ internal sealed class AzureCoreEventSource : AzureEventSource
     {
         private const string EventSourceName = "Azure-Core";
 
-        private const int BackgroundRefreshFailedEvent = 19;
         private const int RequestEvent = 1;
         private const int RequestContentEvent = 2;
-        private const int RequestContentTextEvent = 17;
-        private const int RequestRedirectEvent = 20;
-        private const int RequestRedirectBlockedEvent = 21;
-        private const int RequestRedirectCountExceededEvent = 22;
         private const int ResponseEvent = 5;
         private const int ResponseContentEvent = 6;
         private const int ResponseDelayEvent = 7;
-        private const int ResponseContentTextEvent = 13;
-        private const int ResponseContentBlockEvent = 11;
-        private const int ResponseContentTextBlockEvent = 15;
         private const int ErrorResponseEvent = 8;
         private const int ErrorResponseContentEvent = 9;
-        private const int ErrorResponseContentTextEvent = 14;
+        private const int RequestRetryingEvent = 10;
+        private const int ResponseContentBlockEvent = 11;
         private const int ErrorResponseContentBlockEvent = 12;
+        private const int ResponseContentTextEvent = 13;
+        private const int ErrorResponseContentTextEvent = 14;
+        private const int ResponseContentTextBlockEvent = 15;
         private const int ErrorResponseContentTextBlockEvent = 16;
-        private const int RequestRetryingEvent = 10;
+        private const int RequestContentTextEvent = 17;
         private const int ExceptionResponseEvent = 18;
+        private const int BackgroundRefreshFailedEvent = 19;
+        private const int RequestRedirectEvent = 20;
+        private const int RequestRedirectBlockedEvent = 21;
+        private const int RequestRedirectCountExceededEvent = 22;
+        private const int PipelineTransportOptionsNotAppliedEvent = 23;
 
         private AzureCoreEventSource() : base(EventSourceName) { }
 
@@ -154,5 +156,13 @@ public void RequestRedirectCountExceeded(string requestId, string from, string t
         {
             WriteEvent(RequestRedirectCountExceededEvent, requestId, from, to);
         }
+
+        [Event(
+            PipelineTransportOptionsNotAppliedEvent,
+            Level = EventLevel.Warning, Message = "PipelineTransportOptions where provided for options type [{0}] but were not applied because a custom Transport has already been set.")]
+        public void PipelineTransportOptionsNotApplied(Type optionsType)
+        {
+            WriteEvent(PipelineTransportOptionsNotAppliedEvent, optionsType.FullName);
+        }
     }
 }

sdk/core/Azure.Core/src/Pipeline/HttpClientTransport.cs

@@ -34,7 +34,7 @@ public HttpClientTransport() : this(CreateDefaultClient())
         /// Creates a new <see cref="HttpClientTransport"/> instance using default configuration.
         /// </summary>
         /// <param name="options">The <see cref="HttpPipelineTransportOptions"/> that to configure the behavior of the transport.</param>
-        public HttpClientTransport(HttpPipelineTransportOptions? options = null) : this(CreateDefaultClient(options))
+        internal HttpClientTransport(HttpPipelineTransportOptions? options = null) : this(CreateDefaultClient(options))
         { }
 
         /// <summary>

sdk/core/Azure.Core/src/Pipeline/HttpPipelineBuilder.cs

@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using Azure.Core.Diagnostics;
 
 namespace Azure.Core.Pipeline
 {
@@ -32,7 +33,25 @@ public static HttpPipeline Build(ClientOptions options, params HttpPipelinePolic
         /// <param name="perRetryPolicies">Client provided per-retry policies.</param>
         /// <param name="responseClassifier">The client provided response classifier.</param>
         /// <returns>A new instance of <see cref="HttpPipeline"/></returns>
-        public static HttpPipeline Build(ClientOptions options, HttpPipelinePolicy[] perCallPolicies, HttpPipelinePolicy[] perRetryPolicies, ResponseClassifier responseClassifier)
+        public static HttpPipeline Build(
+            ClientOptions options,
+            HttpPipelinePolicy[] perCallPolicies,
+            HttpPipelinePolicy[] perRetryPolicies,
+            ResponseClassifier responseClassifier)
+        {
+            return Build(options, perCallPolicies, perRetryPolicies, responseClassifier, null);
+        }
+
+        /// <summary>
+        /// Creates an instance of <see cref="HttpPipeline"/> populated with default policies, customer provided policies from <paramref name="options"/> and client provided per call policies.
+        /// </summary>
+        /// <param name="options">The customer provided client options object.</param>
+        /// <param name="perCallPolicies">Client provided per-call policies.</param>
+        /// <param name="perRetryPolicies">Client provided per-retry policies.</param>
+        /// <param name="responseClassifier">The client provided response classifier.</param>
+        /// <param name="pipelineTransportOptions">The customer provided transport options.</param>
+        /// <returns>A new instance of <see cref="HttpPipeline"/></returns>
+        public static HttpPipeline Build(ClientOptions options, HttpPipelinePolicy[] perCallPolicies, HttpPipelinePolicy[] perRetryPolicies, ResponseClassifier responseClassifier, HttpPipelineTransportOptions? pipelineTransportOptions = null)
         {
             if (perCallPolicies == null)
             {
@@ -104,7 +123,25 @@ void AddCustomerPolicies(HttpPipelinePosition position)
 
             policies.RemoveAll(static policy => policy == null);
 
-            return new HttpPipeline(options.Transport,
+            // Override the provided Transport with the provided transport options if the transport has not been set after default construction and options are not null.
+            HttpPipelineTransport transport = options.Transport;
+            if (pipelineTransportOptions != null)
+            {
+                if (options.IsCustomTransportSet)
+                {
+                    if (AzureCoreEventSource.Singleton.IsEnabled())
+                    {
+                        // Log that we were unable to override the custom transport
+                        AzureCoreEventSource.Singleton.PipelineTransportOptionsNotApplied(options.GetType());
+                    }
+                }
+                else
+                {
+                    transport = HttpPipelineTransport.Create(pipelineTransportOptions);
+                }
+            }
+
+            return new HttpPipeline(transport,
                 policies.ToArray(),
                 responseClassifier);
         }

sdk/core/Azure.Core/src/Pipeline/HttpPipelineTransport.cs

@@ -34,7 +34,7 @@ public abstract class HttpPipelineTransport
         /// </summary>
         /// <param name="options"><see cref="HttpPipelineTransportOptions"/> that affect how the transport is configured.</param>
         /// <returns></returns>
-        public static HttpPipelineTransport Create(HttpPipelineTransportOptions? options = null)
+        internal static HttpPipelineTransport Create(HttpPipelineTransportOptions? options = null)
         {
 #if NETFRAMEWORK
             if (!AppContextSwitchHelper.GetConfigValue(

sdk/core/Azure.Core/src/Pipeline/HttpWebRequestTransport.cs

@@ -33,7 +33,7 @@ public HttpWebRequestTransport() : this(_ => { })
         {
         }
 
-        public HttpWebRequestTransport(HttpPipelineTransportOptions options)
+        internal HttpWebRequestTransport(HttpPipelineTransportOptions options)
             : this(req => ApplyOptionsToRequest(req, options))
         { }