diff --git a/src/Accounts/Accounts/Common/AzureContextModificationCmdlet.cs b/src/Accounts/Accounts/Common/AzureContextModificationCmdlet.cs index 599a4e7a0fb0..4c7c1e1343fd 100644 --- a/src/Accounts/Accounts/Common/AzureContextModificationCmdlet.cs +++ b/src/Accounts/Accounts/Common/AzureContextModificationCmdlet.cs @@ -188,6 +188,7 @@ protected bool TryGetExistingContextNameParameter(string name, out RuntimeDefin /// Generate a runtime parameter with ValidateSet matching the current context /// /// The name of the parameter + /// /// The returned runtime parameter for context, with appropriate validate set /// True if one or more contexts were found, otherwise false protected bool TryGetExistingContextNameParameter(string name, string parameterSetName, out RuntimeDefinedParameter runtimeParameter) diff --git a/src/Accounts/Accounts/CommonModule/AzModule.cs b/src/Accounts/Accounts/CommonModule/AzModule.cs index 69588e52b50b..53e2d889a0b6 100644 --- a/src/Accounts/Accounts/CommonModule/AzModule.cs +++ b/src/Accounts/Accounts/CommonModule/AzModule.cs @@ -117,7 +117,7 @@ public void OnModuleLoad(string resourceId, string moduleName, PipelineChangeDel /// The that is being thrown (if available) public async Task EventListener(string id, CancellationToken cancellationToken, GetEventData getEventData, SignalDelegate signal, InvocationInfo invocationInfo, string parameterSetName, string correlationId, string processRecordId, System.Exception exception) { - /// Drain the queue of ADAL events whenever an event is fired + // Drain the queue of ADAL events whenever an event is fired DrainDeferredEvents(signal, cancellationToken); switch (id) { @@ -159,6 +159,7 @@ public async Task EventListener(string id, CancellationToken cancellationToken, /// a string containing the name of the event being raised (well-known events are in /// The from the cmdlet /// The containing the name of the parameter set for this invocation (if available> + /// public void Telemetry(string id, InvocationInfo invocationInfo, string parameterSetName, PSCmdlet pscmdlet) { switch (id) @@ -194,7 +195,7 @@ internal async Task OnResponseCreated(string id, CancellationToken cancellationT } } - /// Print formatted response message + // Print formatted response message await signal(Events.Debug, cancellationToken, () => EventHelper.CreateLogEvent(GeneralUtilities.GetLog(response))); } @@ -360,7 +361,7 @@ internal async Task OnBeforeCall(string id, CancellationToken cancellationToken, } } - /// Print formatted request message + // Print formatted request message await signal(Events.Debug, cancellationToken, () => EventHelper.CreateLogEvent(GeneralUtilities.GetLog(request))); } diff --git a/src/Accounts/Accounts/CommonModule/ContextAdapter.cs b/src/Accounts/Accounts/CommonModule/ContextAdapter.cs index 19ce2af43de4..6e6c6ea99d0e 100644 --- a/src/Accounts/Accounts/CommonModule/ContextAdapter.cs +++ b/src/Accounts/Accounts/CommonModule/ContextAdapter.cs @@ -127,9 +127,9 @@ internal void AddAuthorizeRequestHandler( /// string - the type of completer requested (Resource, Location) /// The from the cmdlet /// The containing the correlation id for the cmdlet (if available) - /// An containing resource (or resource types) being completed - /// An containing list of parent resource parameter names (if applicable) - /// A containing the valid options for the completer. + /// An [] containing resource (or resource types) being completed + /// An [] containing list of parent resource parameter names (if applicable) + /// A [] containing the valid options for the completer. public string[] CompleteArgument(string completerName, InvocationInfo invocationInfo, string correlationId, string[] resourceTypes, string[] parentResourceParameterNames) { var defaultValue = new string[0]; @@ -247,6 +247,9 @@ internal Func /// /// + /// + /// + /// /// /// internal async Task AuthorizeRequest(IAzureContext context, HttpRequestMessage request, CancellationToken cancellationToken, string endpointResourceIdKey, diff --git a/src/Accounts/Accounts/CommonModule/EnvironmentExtensions.cs b/src/Accounts/Accounts/CommonModule/EnvironmentExtensions.cs index 89e4081c243e..8ea08ef861a2 100644 --- a/src/Accounts/Accounts/CommonModule/EnvironmentExtensions.cs +++ b/src/Accounts/Accounts/CommonModule/EnvironmentExtensions.cs @@ -295,6 +295,7 @@ internal static string RemoveAtStart(this string target, params char[] character /// /// /// + /// /// internal static bool ContainsNotNull(this string target, string searchValue, StringComparison comparison = StringComparison.OrdinalIgnoreCase) { diff --git a/src/Accounts/Accounts/CommonModule/EventData.cs b/src/Accounts/Accounts/CommonModule/EventData.cs index 9cd9008d5fc2..a7cae6449ec9 100644 --- a/src/Accounts/Accounts/CommonModule/EventData.cs +++ b/src/Accounts/Accounts/CommonModule/EventData.cs @@ -25,13 +25,13 @@ namespace Microsoft.Azure.Commands.Common using GetParameterDelegate = Func; using SendAsyncStep = Func>; using PipelineChangeDelegate = Action; - - [TypeConverter(typeof(EventDataConverter))] + /// /// In PowerShell, we add on the EventDataConverter to support sending events between modules. /// Obviously, this code would need to be duplcated on both modules. /// This is preferable to sharing a common library, as versioning makes that problematic. /// + [TypeConverter(typeof(EventDataConverter))] public partial class EventData : EventArgs { /// diff --git a/src/Accounts/Accounts/CommonModule/TelemetryProvider.cs b/src/Accounts/Accounts/CommonModule/TelemetryProvider.cs index 4588a42ffbf8..c2ae6aa20a9d 100644 --- a/src/Accounts/Accounts/CommonModule/TelemetryProvider.cs +++ b/src/Accounts/Accounts/CommonModule/TelemetryProvider.cs @@ -134,6 +134,7 @@ public virtual void Flush() /// /// /// + /// /// public virtual AzurePSQoSEvent CreateQosEvent(InvocationInfo invocationInfo, string parameterSetName, string correlationId, string processRecordId) { diff --git a/src/Accounts/Accounts/CommonModule/VTable.cs b/src/Accounts/Accounts/CommonModule/VTable.cs index 6b9bc5684110..7e8a57fa8e71 100644 --- a/src/Accounts/Accounts/CommonModule/VTable.cs +++ b/src/Accounts/Accounts/CommonModule/VTable.cs @@ -42,12 +42,16 @@ public class VTable /// /// The cmdlet will call this when it is trying to fill in a parameter value that it needs /// - /// stringcontaining the expected resource id (ie, ARM). - /// stringcontaining the name of the module being loaded. - /// The from the cmdlet - /// The containing the correlation id for the cmdlet - /// The parameter name being asked for - /// public object GetParameterValue(string resourceId, string moduleName, System.Management.Automation.InvocationInfo invocationInfo, string name) + /// + /// + /// public object GetParameterValue(string resourceId, string moduleName, System.Management.Automation.InvocationInfo invocationInfo, string name) + /// + /// resourceId: stringcontaining the expected resource id (ie, ARM). + /// moduleName: stringcontaining the name of the module being loaded. + /// invocationInfo: The from the cmdlet + /// correlationId: The containing the correlation id for the cmdlet + /// name: The parameter name being asked for + /// public GetParameterDelegate GetParameterValue; public GetTelemetryIdDelegate GetTelemetryId; @@ -58,34 +62,40 @@ public class VTable /// /// The cmdlet will call this for every event during the pipeline. /// - /// a string containing the name of the event being raised (well-known events are in - /// a CancellationToken indicating if this request is being cancelled. - /// a delegate to call to get the event data for this event - /// a delegate to signal an event from the handler to the cmdlet. - /// The from the cmdlet - /// The containing the name of the parameter set for this invocation (if available> - /// The containing the correlation id for the cmdlet (if available) - /// The containing the correlation id for the individual process record. (if available) - /// The that is being thrown (if available) + /// + /// id: a string containing the name of the event being raised (well-known events are in + /// cancellationToken: a CancellationToken indicating if this request is being cancelled. + /// getEventData: a delegate to call to get the event data for this event + /// signal: a delegate to signal an event from the handler to the cmdlet. + /// invocationInfo: The from the cmdlet + /// parameterSetName: The containing the name of the parameter set for this invocation (if available> + /// correlationId: The containing the correlation id for the cmdlet (if available) + /// processRecordId: The containing the correlation id for the individual process record. (if available) + /// exception: The that is being thrown (if available) + /// public EventListenerDelegate EventListener; /// /// Called when the module is loading. Allows adding HTTP pipeline steps that will always be present. /// - /// stringcontaining the expected resource id (ie, ARM). - /// stringcontaining the name of the module being loaded. - /// a delegate which allows the module to prepend a step in the HTTP Pipeline - /// a delegate which allows the module to append a step in the HTTP Pipeline + /// + /// resourceId: stringcontaining the expected resource id (ie, ARM). + /// moduleName: stringcontaining the name of the module being loaded. + /// prependStep: a delegate which allows the module to prepend a step in the HTTP Pipeline + /// appendStep: a delegate which allows the module to append a step in the HTTP Pipeline + /// public ModuleLoadPipelineDelegate OnModuleLoad; /// /// Called when the cmdlet is constructing a new Request /// - /// The from the cmdlet - /// The containing the correlation id for the cmdlet (if available) - /// The containing the correlation id for the individual process record. (if available) - /// a delegate which allows the module to prepend a step in the HTTP Pipeline - /// a delegate which allows the module to append a step in the HTTP Pipeline + /// + /// invocationInfo: The from the cmdlet + /// correlationId: The containing the correlation id for the cmdlet (if available) + /// processRecordId: The containing the correlation id for the individual process record. (if available) + /// prependStep: a delegate which allows the module to prepend a step in the HTTP Pipeline + /// appendStep: a delegate which allows the module to append a step in the HTTP Pipeline + /// public NewRequestPipelineDelegate OnNewRequest; public NewRequestPipelineDelegate AddRequestUserAgentHandler; @@ -95,13 +105,16 @@ public class VTable public AuthorizeRequestDelegate AddAuthorizeRequestHandler; /// - /// Called for well-known parameters that require argument completers + /// Called for well-known parameters that require argument completers, it /// - /// string - the type of completer requested (Resource, Location) - /// The from the cmdlet - /// The containing the correlation id for the cmdlet (if available) - /// An containing resource (or resource types) being completed - /// An containing list of parent resource parameter names (if applicable) + /// + /// public string[] ArgumentCompleter(string completerName, System.Management.Automation.InvocationInfo invocationInfo, string correlationId, string[] resourceTypes, string[] parentResourceParameterNames) + /// completerName: string - the type of completer requested (Resource, Location) + /// invocationInfo: The from the cmdlet + /// correlationId: The containing the correlation id for the cmdlet (if available) + /// resourceTypes: An [] containing resource (or resource types) being completed + /// parentResourceParameterNames: An [] containing list of parent resource parameter names (if applicable) + /// /// A string[] containing the valid options for the completer. public ArgumentCompleterDelegate ArgumentCompleter; diff --git a/src/Accounts/Accounts/Models/AzureRmProfileExtensions.cs b/src/Accounts/Accounts/Models/AzureRmProfileExtensions.cs index 15f2530c7e87..9a866e88de4e 100644 --- a/src/Accounts/Accounts/Models/AzureRmProfileExtensions.cs +++ b/src/Accounts/Accounts/Models/AzureRmProfileExtensions.cs @@ -32,6 +32,7 @@ public static class AzureRMProfileExtensions /// /// The profile to change the context for /// The new context, with no token cache information. + /// public static void SetContextWithCache(this IAzureContextContainer profile, IAzureContext newContext, string name = null) { if (profile == null) diff --git a/src/Accounts/Accounts/Utilities/HttpRequestMessageExtension.cs b/src/Accounts/Accounts/Utilities/HttpRequestMessageExtension.cs index c24601f7afa9..0dfd72579838 100644 --- a/src/Accounts/Accounts/Utilities/HttpRequestMessageExtension.cs +++ b/src/Accounts/Accounts/Utilities/HttpRequestMessageExtension.cs @@ -40,6 +40,8 @@ internal static Task CloneWithContentAndDispose(this HttpReq /// Clones an HttpRequestMessage (without the content) /// /// Original HttpRequestMessage (Will be diposed before returning) + /// + /// /// A clone of the HttpRequestMessage internal static HttpRequestMessage Clone(this HttpRequestMessage original, System.Uri requestUri = null, System.Net.Http.HttpMethod method = null) { @@ -74,6 +76,8 @@ internal static HttpRequestMessage Clone(this HttpRequestMessage original, Syste /// Clones an HttpRequestMessage (including the content stream and content headers) /// /// Original HttpRequestMessage (Will be diposed before returning) + /// + /// /// A clone of the HttpRequestMessage internal static async Task CloneWithContent(this HttpRequestMessage original, System.Uri requestUri = null, System.Net.Http.HttpMethod method = null) {