Updated XML docs for UseDefaultCredentialsForProxy (#175)

Author: snakefoot

src/NLog.Extensions.AzureBlobStorage/BlobStorageTarget.cs

@@ -130,8 +130,9 @@ public sealed class BlobStorageTarget : AsyncTaskTarget
         public Layout ProxyPassword { get; set; }
 
         /// <summary>
-        /// Uses the default credentials (<see cref="System.Net.CredentialCache.DefaultCredentials"/>) for the proxy server, overriding any values that may have been set in <see cref="ProxyLogin"/> and <see cref="ProxyPassword"/>.
+        /// Uses the default credentials (<see cref="System.Net.CredentialCache.DefaultCredentials"/>) for the proxy server.
         /// </summary>
+        /// <remarks>Take precedence over <see cref = "ProxyLogin" /> and <see cref="ProxyPassword"/> when set to <see langword="true"/>.</remarks>
         public bool UseDefaultCredentialsForProxy { get; set; }
 
         /// <summary>

src/NLog.Extensions.AzureBlobStorage/README.md

@@ -69,7 +69,7 @@ _proxyLogin_ - Login to use for the proxy server. Requires `proxyPassword`.
 
 _proxyPassword_ - Password to use for the proxy server. Requires `proxyLogin`.
 
-_useDefaultCredentialsForProxy_ - Uses the default credentials (`System.Net.CredentialCache.DefaultCredentials`) for the proxy server.
+_useDefaultCredentialsForProxy_ - Uses the default credentials (`System.Net.CredentialCache.DefaultCredentials`) for the proxy server. Take precedence over `proxyLogin` and `proxyPassword` when set to `true`.
 
 ### Batching Policy
 

src/NLog.Extensions.AzureDataTables/DataTablesTarget.cs

@@ -167,11 +167,11 @@ public override int GetHashCode()
         public Layout ProxyPassword { get; set; }
 
         /// <summary>
-        /// Uses the default credentials (<see cref="System.Net.CredentialCache.DefaultCredentials"/>) for the proxy server, overriding any values that may have been set in <see cref="ProxyLogin"/> and <see cref="ProxyPassword"/>.
+        /// Uses the default credentials (<see cref="System.Net.CredentialCache.DefaultCredentials"/>) for the proxy server.
         /// </summary>
+        /// <remarks>Take precedence over <see cref = "ProxyLogin" /> and <see cref="ProxyPassword"/> when set to <see langword="true"/>.</remarks>
         public bool UseDefaultCredentialsForProxy { get; set; }
 
-
         /// <summary>
         /// Gets or sets the name of the Azure table where log entries will be stored.
         /// </summary>

src/NLog.Extensions.AzureDataTables/README.md

@@ -68,7 +68,7 @@ _proxyLogin_ - Login to use for the proxy server. Requires `proxyPassword`.
 
 _proxyPassword_ - Password to use for the proxy server. Requires `proxyLogin`.
 
-_useDefaultCredentialsForProxy_ - Uses the default credentials (`System.Net.CredentialCache.DefaultCredentials`) for the proxy server.
+_useDefaultCredentialsForProxy_ - Uses the default credentials (`System.Net.CredentialCache.DefaultCredentials`) for the proxy server. Take precedence over `proxyLogin` and `proxyPassword` when set to `true`.
 
 ### Dynamic TableEntity
 Instead of using the predefined NLogEntity-properties, then one can specify wanted properties:

src/NLog.Extensions.AzureEventGrid/EventGridTarget.cs

@@ -152,8 +152,9 @@ public string DataFormat
         public Layout ProxyPassword { get; set; }
 
         /// <summary>
-        /// Uses the default credentials (<see cref="System.Net.CredentialCache.DefaultCredentials"/>) for the proxy server, overriding any values that may have been set in <see cref="ProxyLogin"/> and <see cref="ProxyPassword"/>.
+        /// Uses the default credentials (<see cref="System.Net.CredentialCache.DefaultCredentials"/>) for the proxy server.
         /// </summary>
+        /// <remarks>Take precedence over <see cref = "ProxyLogin" /> and <see cref="ProxyPassword"/> when set to <see langword="true"/>.</remarks>
         public bool UseDefaultCredentialsForProxy { get; set; }
 
         /// <summary>

src/NLog.Extensions.AzureEventGrid/README.md

@@ -74,7 +74,7 @@ _proxyLogin_ - Login to use for the proxy server. Requires `proxyPassword`.
 
 _proxyPassword_ - Password to use for the proxy server. Requires `proxyLogin`.
 
-_useDefaultCredentialsForProxy_ - Uses the default credentials (`System.Net.CredentialCache.DefaultCredentials`) for the proxy server.
+_useDefaultCredentialsForProxy_ - Uses the default credentials (`System.Net.CredentialCache.DefaultCredentials`) for the proxy server. Take precedence over `proxyLogin` and `proxyPassword` when set to `true`.
 
 ### Retry Policy
 

src/NLog.Extensions.AzureEventHub/EventHubTarget.cs

@@ -201,9 +201,9 @@ public class EventHubTarget : AsyncTaskTarget
         public Layout ProxyPassword { get; set; }
 
         /// <summary>
-        /// Uses the default credentials (<see cref="System.Net.CredentialCache.DefaultCredentials"/>) for the proxy server, overriding any values that may have been set in <see cref="ProxyLogin"/> and <see cref="ProxyPassword"/>.
+        /// Uses the default credentials (<see cref="System.Net.CredentialCache.DefaultCredentials"/>) for the proxy server.
         /// </summary>
-        /// <remarks>Only applies when <see cref="UseWebSockets"/> = <see langword="true"/></remarks>
+        /// <remarks>Only applies when <see cref="UseWebSockets"/> = <see langword="true"/>. Take precedence over <see cref = "ProxyLogin" /> and <see cref="ProxyPassword"/> when set to <see langword="true"/>.</remarks>
         public bool UseDefaultCredentialsForProxy { get; set; }
 
         /// <summary>
@@ -261,7 +261,6 @@ protected override void InitializeTarget()
             string clientAuthSecret = string.Empty;
             string eventHubName = string.Empty;
             string useWebSockets = string.Empty;
-            string webSocketProxyAddress = string.Empty;
             string customEndPointAddress = string.Empty;
             string eventProducerIdentifier = string.Empty;
 
@@ -287,7 +286,7 @@ protected override void InitializeTarget()
                 eventProducerIdentifier = EventProducerIdentifier?.Render(defaultLogEvent) ?? string.Empty;
 
                 useWebSockets = UseWebSockets?.Render(defaultLogEvent) ?? string.Empty;
-                if (!string.IsNullOrEmpty(useWebSockets) && (string.Equals(useWebSockets.Trim(), bool.TrueString, StringComparison.OrdinalIgnoreCase) || string.Equals(useWebSockets.Trim(), "1", StringComparison.OrdinalIgnoreCase)))
+                if (string.Equals(useWebSockets.Trim(), bool.TrueString, StringComparison.OrdinalIgnoreCase) || string.Equals(useWebSockets.Trim(), "1", StringComparison.OrdinalIgnoreCase))
                 {
                     useWebSockets = bool.TrueString;
                 }
@@ -301,7 +300,6 @@ protected override void InitializeTarget()
                     Login = ProxyLogin?.Render(defaultLogEvent),
                     Password = ProxyPassword?.Render(defaultLogEvent)
                 };
-                proxySettings = proxySettings.RequiresManualProxyConfiguration ? proxySettings : null;
 
                 _eventHubService.Connect(connectionString, eventHubName, serviceUri, tenantIdentity, managedIdentityResourceId, managedIdentityClientId, sharedAccessSignature, storageAccountName, storageAccountAccessKey, clientAuthId, clientAuthSecret, eventProducerIdentifier, bool.TrueString == useWebSockets, customEndPointAddress, proxySettings);
                 InternalLogger.Debug("AzureEventHubTarget(Name={0}): Initialized", Name);
@@ -615,7 +613,7 @@ public void Connect(string connectionString, string eventHubName, string service
                 {
                     options = new Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions();
                     options.ConnectionOptions.TransportType = useWebSockets ? EventHubsTransportType.AmqpWebSockets : options.ConnectionOptions.TransportType;
-                    if (useWebSockets && proxySettings != null)
+                    if (useWebSockets && proxySettings?.RequiresManualProxyConfiguration == true)
                         options.ConnectionOptions.Proxy = proxySettings.CreateWebProxy(options.ConnectionOptions.Proxy);
                     if (!string.IsNullOrEmpty(endPointAddress))
                         options.ConnectionOptions.CustomEndpointAddress = new Uri(endPointAddress);

src/NLog.Extensions.AzureEventHub/README.md

@@ -88,7 +88,7 @@ _proxyLogin_ - Login to use for the proxy server. Requires `proxyPassword`. Requ
 
 _proxyPassword_ - Password to use for the proxy server. Requires `proxyLogin`. Requires `useWebSockets = true`.
 
-_useDefaultCredentialsForProxy_ - Uses the default credentials (`System.Net.CredentialCache.DefaultCredentials`) for the proxy server. Requires `useWebSockets = true`.
+_useDefaultCredentialsForProxy_ - Uses the default credentials (`System.Net.CredentialCache.DefaultCredentials`) for the proxy server. Take precedence over `proxyLogin` and `proxyPassword` when set to `true`. Requires `useWebSockets = true`.
 
 ### Batching Policy
 

src/NLog.Extensions.AzureQueueStorage/QueueStorageTarget.cs

@@ -126,8 +126,9 @@ public sealed class QueueStorageTarget : AsyncTaskTarget
         public Layout ProxyPassword { get; set; }
 
         /// <summary>
-        /// Uses the default credentials (<see cref="System.Net.CredentialCache.DefaultCredentials"/>) for the proxy server, overriding any values that may have been set in <see cref="ProxyLogin"/> and <see cref="ProxyPassword"/>.
+        /// Uses the default credentials (<see cref="System.Net.CredentialCache.DefaultCredentials"/>) for the proxy server.
         /// </summary>
+        /// <remarks>Take precedence over <see cref = "ProxyLogin" /> and <see cref="ProxyPassword"/> when set to <see langword="true"/>.</remarks>
         public bool UseDefaultCredentialsForProxy { get; set; }
 
         /// <summary>

src/NLog.Extensions.AzureQueueStorage/README.md

@@ -67,7 +67,7 @@ _proxyLogin_ - Login to use for the proxy server. Requires `proxyPassword`.
 
 _proxyPassword_ - Password to use for the proxy server. Requires `proxyLogin`.
 
-_useDefaultCredentialsForProxy_ - Uses the default credentials (`System.Net.CredentialCache.DefaultCredentials`) for the proxy server.
+_useDefaultCredentialsForProxy_ - Uses the default credentials (`System.Net.CredentialCache.DefaultCredentials`) for the proxy server. Take precedence over `proxyLogin` and `proxyPassword` when set to `true`.
 
 ### Batching Policy