azureauth 0.1.0 → 0.3.0

package/bin/azureauth/azureauth.xml

@@ -1,803 +0,0 @@
-<?xml version="1.0"?>
-<doc>
-    <assembly>
-        <name>azureauth</name>
-    </assembly>
-    <members>
-        <member name="T:Microsoft.Authentication.AzureAuth.Ado.Authorization">
-            <summary>
-            Authorization Header schemes.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Authorization.Basic">
-            <summary> Base64 encoded basic authorization. </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Authorization.Bearer">
-            <summary> Bearer token authorization. </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Ado.AuthParameters">
-            <summary>Azure DevOps-specific authentication parameters.</summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Ado.AuthParameters.AdoParameters(System.String)">
-            <summary>Create Azure DevOps-specific authentication parameters.</summary>
-            <param name="tenant">The tenant. Defaults to Microsoft.</param>
-            <returns>A new instance of the <see cref="T:Microsoft.Authentication.MSALWrapper.AuthParameters"/> class.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Ado.Constants">
-            <summary>
-            Azure DevOps constant values.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.PreferredDomain">
-            <summary>The default preferred domain used when retrieving cached accounts.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.BaseUrl">
-            <summary>The base URL for Azure DevOps.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.PatLockfileName">
-            <summary>The PAT lockfile name. The containing directory is platform specific, thus configured at runtime.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.SystemDefinitionId">
-            <summary>
-            ADO pipeline id.
-            This is defined by ADO pipelines. See https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables.
-            </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Ado.Constants.Tenant">
-            <summary>
-            Azure tenant IDs.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.Tenant.Microsoft">
-            <summary>
-            Microsoft tenant ID.
-            </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Ado.Constants.Client">
-            <summary>
-            App Registration Client IDs.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.Client.VisualStudio">
-            <summary>
-            Visual Studio 2019 and earlier client ID.
-            </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Ado.Constants.Scope">
-            <summary>
-            Resource Scopes.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.Scope.AzureDevOpsDefault">
-            <summary>
-            The default scope used for Azure DevOps.
-            </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Ado.Constants.PatStorageParameters">
-            <summary>Parameters used to configure persistent, encrypted storage for Azure DevOps PATs.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.PatStorageParameters.CacheFileName">
-            <summary>The PAT cache file. The containing directory is platform and user specific, thus configured at runtime.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.PatStorageParameters.MacOSAccountName">
-            <summary>The Mac keychain account name.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.PatStorageParameters.MacOSServiceName">
-            <summary>The Mac keychain service name.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.PatStorageParameters.LinuxKeyRingSchemaName">
-            <summary>The Linux keyring schema name.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.PatStorageParameters.LinuxKeyRingLabel">
-            <summary>The user-readable label for the Linux keyring secret.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.PatStorageParameters.LinuxKeyRingCollection">
-            <summary>The Linux keyring collection. "default" is persisted, "session" is destroyed on logout.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.PatStorageParameters.LinuxKeyRingAttr1">
-            <summary>An additional attribute used to decorate the Linux keyring secret.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Ado.Constants.PatStorageParameters.LinuxKeyRingAttr2">
-            <summary>Another additional attribute used to decorate the Linux keyring secret.</summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Ado.PatFromEnv">
-            <summary>
-            A class for getting an ADO PAT from an <see cref="T:Microsoft.Office.Lasso.Interfaces.IEnv"/> or an AAD access token through MSAL.
-            </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Ado.PatFromEnv.Result">
-            <summary>
-            The result for retrieving a PAT out of the environment.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Ado.PatFromEnv.Result.Exists">
-            <summary>
-            Gets a value indicating whether a PAT was found in the environment.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Ado.PatFromEnv.Result.EnvVarSource">
-            <summary>
-            Gets the source env var that contained the PAT.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Ado.PatFromEnv.Result.Value">
-            <summary>
-            Gets the PAT value itself.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Ado.PatFromEnv.Get(Microsoft.Office.Lasso.Interfaces.IEnv)">
-            <summary>
-            Get an ADO PAT from the environment.
-            </summary>
-            <param name="env">The <see cref="T:Microsoft.Office.Lasso.Interfaces.IEnv"/> to use for interacting with the environment.</param>
-            <returns>A <see cref="T:Microsoft.Authentication.AzureAuth.Ado.PatFromEnv.Result"/>.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Ado.TokenFormattingExtensions">
-            <summary>
-            <see cref="T:System.String"/> extension methods for formatting tokens.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Ado.TokenFormattingExtensions.Base64(System.String)">
-            <summary>
-            Base64 encode <paramref name="value"/> adding padding (=) characters as needed.
-            </summary>
-            <param name="value">Value to base64 encode.</param>
-            <returns>Base64 encoded value.</returns>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Ado.TokenFormattingExtensions.AsHeader(System.String,Microsoft.Authentication.AzureAuth.Ado.Authorization)">
-            <summary>
-            Create an Authorization Header.
-            Handles base64 encoding of <paramref name="value"/> for <see cref="F:Microsoft.Authentication.AzureAuth.Ado.Authorization.Basic"/> credentials.
-            </summary>
-            <param name="value">The credential.</param>
-            <param name="scheme"><see cref="T:Microsoft.Authentication.AzureAuth.Ado.Authorization"/> scheme.</param>
-            <returns>A full Authorization header using the Basic scheme.</returns>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Ado.TokenFormattingExtensions.AsHeaderValue(System.String,Microsoft.Authentication.AzureAuth.Ado.Authorization)">
-            <summary>
-            Create an Authorization Header Value (without the Authorization prefix/key).
-            Handles base64 encoding of <paramref name="value"/> for <see cref="F:Microsoft.Authentication.AzureAuth.Ado.Authorization.Basic"/> credentials.
-            </summary>
-            <param name="value">The credential.</param>
-            /// <param name="scheme"><see cref="T:Microsoft.Authentication.AzureAuth.Ado.Authorization"/> scheme.</param>
-            <returns>The Authorization header value.</returns>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Ado.TokenFormattingExtensions.FormatValue(Microsoft.Authentication.AzureAuth.Ado.Authorization,System.String)">
-            <summary>
-            For Basic scheme, we expect to be using PATs - so we inject a ':' ahead of the value
-            to denote an empty username before the password.
-            </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Alias">
-            <summary>
-            The alias contains information that the auth process needs.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Alias.Resource">
-            <summary>
-            Gets or sets the resource.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Alias.Client">
-            <summary>
-            Gets or sets the client.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Alias.Domain">
-            <summary>
-            Gets or sets the domain.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Alias.Tenant">
-            <summary>
-            Gets or sets the tenant.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Alias.PromptHint">
-            <summary>
-            Gets or sets the customized prompt hint.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Alias.Scopes">
-            <summary>
-            Gets or sets the scopes.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Alias.Override(Microsoft.Authentication.AzureAuth.Alias)">
-            <summary>
-            The override method creates a new <see cref="T:Microsoft.Authentication.AzureAuth.Alias"/> instance which merges two Alias fields.
-            Non-null fields in the given parameter will replace original fields.
-            </summary>
-            <param name="other">
-            The given instance with fields to be replaced.
-            </param>
-            <returns>
-            The merged <see cref="T:Microsoft.Authentication.AzureAuth.Alias"/>.
-            </returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.AuthFlowResultExtensions">
-            <summary>
-            Extension methods for <see cref="T:Microsoft.Authentication.MSALWrapper.AuthFlowResult"/>.
-            </summary>
-            <remarks>
-            These are extension methods on <see cref="T:Microsoft.Authentication.MSALWrapper.AuthFlowResult"/> and
-            <see cref="T:System.Collections.Generic.IEnumerable`1"/> because they use types owned by other libraries (Lasso and MSALWrapper).
-            We don't want to cross those boundaries and make our MSALWRapper aware of types from a CLI framework. AzureAuth is what
-            knows about both these things and is defining functions to move from one to the other. They are extensions purely for
-            syntactic sugar.
-            </remarks>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.AuthFlowResultExtensions.EventData(Microsoft.Authentication.MSALWrapper.AuthFlowResult)">
-            <summary>
-            Convert to an <see cref="T:Microsoft.Office.Lasso.Telemetry.EventData"/>.
-            </summary>
-            <param name="result">Current <see cref="T:Microsoft.Authentication.MSALWrapper.AuthFlowResult"/>.</param>
-            <returns>An <see cref="T:Microsoft.Office.Lasso.Telemetry.EventData"/> representing this <see cref="T:Microsoft.Authentication.MSALWrapper.AuthFlowResult"/>.</returns>
-            <remarks>
-            Why is this an extension method? <see cref="T:Microsoft.Authentication.MSALWrapper.AuthFlowResult"/> is owned by <see cref="N:Microsoft.Authentication.MSALWrapper"/>
-            and <see cref="T:Microsoft.Office.Lasso.Telemetry.EventData"/> is owned by <see cref="N:Microsoft.Office.Lasso"/>.
-            So <see cref="T:Microsoft.Authentication.MSALWrapper.AuthFlowResult"/> does not actually know what an <see cref="T:Microsoft.Office.Lasso.Telemetry.EventData"/> is
-            without bringing a reference to the CLI framework into the <see cref="N:Microsoft.Authentication.MSALWrapper"/>. This is not a boundary we want to cross.
-            Instead, here in AzureAuth, we can define the conversion using an extension method to house it rather than an arbitrary
-            static class to hold the same function. Being an extension here is purely syntactic sugar. The main preference is
-            around defining a "pure" function for this.
-            </remarks>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.AuthFlowResultExtensions.SendTelemetry(System.Collections.Generic.IEnumerable{Microsoft.Authentication.MSALWrapper.AuthFlowResult},Microsoft.Office.Lasso.Interfaces.ITelemetryService)">
-            <summary>
-            Send telemetry events for n <see cref="T:Microsoft.Authentication.MSALWrapper.AuthFlowResult"/> instance.
-            </summary>
-            <param name="results"><see cref="T:Microsoft.Authentication.MSALWrapper.AuthFlowResult"/>s to send telemetry for.</param>
-            <param name="telemetryService">The <see cref="T:Microsoft.Office.Lasso.Interfaces.ITelemetryService"/> to use to send the events.</param>
-            /// <remarks>
-            Why is this an extension method? <see cref="T:Microsoft.Authentication.MSALWrapper.AuthFlowResult"/> is owned by <see cref="N:Microsoft.Authentication.MSALWrapper"/>
-            and <see cref="T:Microsoft.Office.Lasso.Interfaces.ITelemetryService"/> is owned by <see cref="N:Microsoft.Office.Lasso"/>.
-            So <see cref="T:Microsoft.Authentication.MSALWrapper.AuthFlowResult"/> does not actually know what a <see cref="T:Microsoft.Office.Lasso.Interfaces.ITelemetryService"/> is
-            without bringing a reference to the CLI framework into the <see cref="N:Microsoft.Authentication.MSALWrapper"/>. This is not a boundary we want to cross.
-            Instead, here in AzureAuth, we can define the conversion using an extension method to house it rather than an arbitrary
-            static class to hold the same function. Being an extension here is purely syntactic sugar. The main preference is
-            around defining a "pure" function for this.
-            </remarks>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.AuthModeExtensions">
-            <summary>
-            Extensions to <see cref="T:Microsoft.Authentication.MSALWrapper.AuthMode"/>s.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.AuthModeExtensions.PreventInteractionIfNeeded(Microsoft.Authentication.MSALWrapper.AuthMode,Microsoft.Office.Lasso.Interfaces.IEnv,Microsoft.Extensions.Logging.ILogger)">
-            <summary>
-            Filters a list of <see cref="T:Microsoft.Authentication.MSALWrapper.AuthMode"/> for interaction returning a single aggregate <see cref="T:Microsoft.Authentication.MSALWrapper.AuthMode"/>.
-            </summary>
-            <param name="authMode">Starting <see cref="T:Microsoft.Authentication.MSALWrapper.AuthMode"/>to filter.</param>
-            <param name="env">An <see cref="T:Microsoft.Office.Lasso.Interfaces.IEnv"/>.</param>
-            <param name="logger">An <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</param>
-            <returns>An <see cref="T:Microsoft.Authentication.MSALWrapper.AuthMode"/> with only non-interactive auth modes allowed, if specificed by the environment.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Commands.Ado.CommandPat">
-            <summary>
-            An ADO Command for creating or fetching, and returning Azure Devops PATs.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Commands.Ado.CommandPat.OnExecute(Microsoft.Extensions.Logging.ILogger{Microsoft.Authentication.AzureAuth.Commands.Ado.CommandPat},Microsoft.Authentication.AzureAuth.IPublicClientAuth,Microsoft.Office.Lasso.Telemetry.CommandExecuteEventData)">
-            <summary>
-            Executes the command and returns a status code indicating the success or failure of the execution.
-            </summary>
-            <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> instance that is used for logging.</param>
-            <param name="publicClientAuth">An <see cref="T:Microsoft.Authentication.AzureAuth.IPublicClientAuth"/>.</param>
-            <param name="eventData">Lasso injected command event data.</param>
-            <returns>An integer status code. 0 for success and non-zero for failure.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Commands.Ado.CommandToken">
-            <summary>
-            ADO Command for using either an ADO PAT or acquiring an AAD Access Token.
-            </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Commands.Ado.CommandToken.OutputMode">
-            <summary>
-            The available Token Formats.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.Ado.CommandToken.OutputMode.Token">
-            <summary>
-            Raw Token
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.Ado.CommandToken.OutputMode.Header">
-            <summary>
-            Authorization http header.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.Ado.CommandToken.OutputMode.HeaderValue">
-            <summary> Authorization http header - Value Only </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Commands.Ado.CommandToken.FormatToken(System.String,Microsoft.Authentication.AzureAuth.Commands.Ado.CommandToken.OutputMode,Microsoft.Authentication.AzureAuth.Ado.Authorization)">
-            <summary>
-            Format a PAT based on <paramref name="output"/>.
-            </summary>
-            <param name="value">The PAT value.</param>
-            <param name="output">The output mode.</param>
-            <param name="scheme">The <see cref="T:Microsoft.Authentication.AzureAuth.Ado.Authorization"/> scheme to use.</param>
-            <returns>The formatted PAT value ready for printing.</returns>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Commands.Ado.CommandToken.OnExecute(Microsoft.Extensions.Logging.ILogger{Microsoft.Authentication.AzureAuth.Commands.Ado.CommandToken},Microsoft.Office.Lasso.Interfaces.IEnv,Microsoft.Office.Lasso.Interfaces.ITelemetryService,Microsoft.Authentication.AzureAuth.IPublicClientAuth,Microsoft.Office.Lasso.Telemetry.CommandExecuteEventData)">
-            <summary>
-            Executes the command and returns a status code indicating the success or failure of the execution.
-            </summary>
-            <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/> instance that is used for logging.</param>
-            <param name="env">An <see cref="T:Microsoft.Office.Lasso.Interfaces.IEnv"/> to use.</param>
-            <param name="telemetryService">An <see cref="T:Microsoft.Office.Lasso.Interfaces.ITelemetryService"/>.</param>
-            <param name="publicClientAuth">An <see cref="T:Microsoft.Authentication.AzureAuth.IPublicClientAuth"/>.</param>
-            <param name="eventData">Lasso injected command event data.</param>
-            <returns>An integer status code. 0 for success and non-zero for failure.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Commands.CommandAad">
-            <summary>
-            Command class for authenticating with AAD.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.DomainOption">
-            <summary>
-            The Domain option.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.TenantOption">
-            <summary>
-            The Tenant option.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.TimeoutOption">
-            <summary>
-            The Timeout option.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.ModeOption">
-            <summary>
-            The Mode option.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.PromptHintOption">
-            <summary>
-            The Prompt Hint option.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.PromptHintHelpText">
-            <summary>
-            The Prompt Hint help text.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.AuthModeHelperText">
-            <summary>
-            The help text for the <see cref="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.ModeOption"/> option.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.DomainHelpText">
-            <summary>
-            The help text for the <see cref="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.DomainOption"/> option.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.TimeoutHelpText">
-            <summary>
-            The help text for the <see cref="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.TimeoutOption"/> option.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Commands.CommandAad.GlobalTimeout">
-            <summary>
-            The default number of minutes CLI is allowed to run.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Commands.CommandAad.#ctor(Microsoft.Office.Lasso.Telemetry.CommandExecuteEventData,Microsoft.Office.Lasso.Interfaces.ITelemetryService,Microsoft.Extensions.Logging.ILogger{Microsoft.Authentication.AzureAuth.Commands.CommandAzureAuth},System.IO.Abstractions.IFileSystem,Microsoft.Office.Lasso.Interfaces.IEnv)">
-            <summary>
-            Initializes a new instance of the <see cref="T:Microsoft.Authentication.AzureAuth.Commands.CommandAad"/> class.
-            </summary>
-            <param name="eventData">The event data.</param>
-            <param name="telemetryService">The telemetry service.</param>
-            <param name="logger">The logger.</param>
-            <param name="fileSystem">The file system.</param>
-            <param name="env">The environment interface.</param>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Commands.CommandAad.#ctor(Microsoft.Office.Lasso.Telemetry.CommandExecuteEventData,Microsoft.Office.Lasso.Interfaces.ITelemetryService,Microsoft.Extensions.Logging.ILogger{Microsoft.Authentication.AzureAuth.Commands.CommandAzureAuth},System.IO.Abstractions.IFileSystem,Microsoft.Office.Lasso.Interfaces.IEnv,Microsoft.Authentication.MSALWrapper.AuthFlow.IAuthFlow)">
-            <summary>
-            Initializes a new instance of the <see cref="T:Microsoft.Authentication.AzureAuth.Commands.CommandAad"/> class.
-            </summary>
-            <param name="eventData">The event data.</param>
-            <param name="telemetryService">The telemetry service.</param>
-            <param name="logger">The logger.</param>
-            <param name="fileSystem">The file system.</param>
-            <param name="env">The environment interface.</param>
-            <param name="authFlow">An injected <see cref="T:Microsoft.Authentication.MSALWrapper.AuthFlow.IAuthFlow"/> (defined for testability).</param>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.Resource">
-            <summary>
-            Gets or sets the resource.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.Client">
-            <summary>
-            Gets or sets the client.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.Tenant">
-            <summary>
-            Gets or sets the tenant.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.PromptHint">
-            <summary>
-            Gets or sets the customized prompt hint text for WAM prompts and web mode.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.Scopes">
-            <summary>
-            Gets or sets the scopes.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.ClearCache">
-            <summary>
-            Gets or sets a value indicating whether clear cache.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.PreferredDomain">
-            <summary>
-            Gets or sets the preferred domain.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.AuthModes">
-            <summary>
-            Gets or sets the auth modes.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.Output">
-            <summary>
-            Gets or sets the output.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.AliasName">
-            <summary>
-            Gets or sets the alias name.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.ConfigFilePath">
-            <summary>
-            Gets or sets the config file path.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.Timeout">
-            <summary>
-            Gets or sets global Timeout.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Commands.CommandAad.TokenFetcherOptions">
-            <summary>
-            Gets the token fetcher options.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Commands.CommandAad.EvaluateOptions">
-            <summary>
-            This method evaluates whether the options are valid or not.
-            </summary>
-            <returns>
-            Whether the option is valid.
-            </returns>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Commands.CommandAad.OnExecute(Microsoft.Authentication.AzureAuth.IPublicClientAuth)">
-            <summary>
-            This method executes the auth process.
-            </summary>
-            <param name="publicClientAuth">An <see cref="T:Microsoft.Authentication.AzureAuth.IPublicClientAuth"/> to handle authentication.</param>
-            <returns>
-            The error code: 0 is normal execution, and the rest means errors during execution.
-            </returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Commands.CommandAdo">
-            <summary>
-            Parent command for Azure Devops specific commands.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Commands.CommandAdo.OnExecute(McMaster.Extensions.CommandLineUtils.CommandLineApplication)">
-            <summary>
-            Execute the command, showing the help text since this is only a parent command. returns 0.
-            </summary>
-            <param name="app">The command app insntace.</param>
-            <returns>An Exit code of 0 since showingthe help should never fail.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Commands.CommandAzureAuth">
-            <summary>
-            The command main class parses commands and dispatches to the corresponding methods.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Commands.CommandAzureAuth.OnExecute(McMaster.Extensions.CommandLineUtils.CommandLineApplication)">
-            <summary> Execute the command. </summary>
-            <param name="app">The current command instance.</param>
-            <returns>0.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Commands.CommandInfo">
-            <summary>
-            The command <see cref="T:Microsoft.Authentication.AzureAuth.Commands.CommandInfo"/> shows debug information and system runtime.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Commands.CommandInfo.OnExecute(Microsoft.Extensions.Logging.ILogger{Microsoft.Authentication.AzureAuth.Commands.CommandInfo},System.IO.Abstractions.IFileSystem,McMaster.Extensions.CommandLineUtils.CommandLineApplication)">
-            <summary>
-            This method executes the info process.
-            </summary>
-            <param name="logger">The logger.</param>
-            <param name="fileSystem">The file system.</param>
-            <param name="app">The command line application.</param>
-            <returns>The error code: 0 is normal execution, and the rest means errors during execution.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Commands.Info.CommandResetDeviceID">
-            <summary>
-            The command <see cref="T:Microsoft.Authentication.AzureAuth.Commands.Info.CommandResetDeviceID"/> reset the device ID in local storage.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Commands.Info.CommandResetDeviceID.OnExecute(Microsoft.Extensions.Logging.ILogger{Microsoft.Authentication.AzureAuth.Commands.Info.CommandResetDeviceID},System.IO.Abstractions.IFileSystem,McMaster.Extensions.CommandLineUtils.CommandLineApplication)">
-            <summary>
-            This method executes the reset device ID process.
-            </summary>
-            <param name="logger">The logger.</param>
-            <param name="fileSystem">The file system.</param>
-            <param name="app">The command line application.</param>
-            <returns>The error code: 0 is normal execution, and the rest means errors during execution.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Config">
-            <summary>
-            A config contains a collection of <see cref="P:Microsoft.Authentication.AzureAuth.Config.Alias"/>.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.Config.Alias">
-            <summary>
-            Gets or sets the alias.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.Config.FromFile(System.String,System.IO.Abstractions.IFileSystem)">
-            <summary>
-            Create a Config instance from a file in the <see cref="T:Tomlyn.Toml"/> format.
-            </summary>
-            <param name="configFile">
-            The full path of config file.
-            </param>
-            <param name="fileSystem">
-            The file system.
-            </param>
-            <returns>
-            The <see cref="T:Microsoft.Authentication.AzureAuth.Config"/>.
-            </returns>
-            <exception cref="T:System.ArgumentException">
-            The argument exception.
-            </exception>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Constants">
-            <summary>AzureAuth constant values.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.Constants.AppDirectory">
-            <summary>
-            The default application directory for AzureAuth.
-            On Windows this is <c>%LOCALAPPDATA%\Programs\AzureAuth</c>.
-            On Unix-like platforms this is <c>~/.azureauth</c>.
-            </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.EnvVars">
-            <summary>
-            A static class to hold env var names.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.EnvVars.CloudBuild">
-            <summary>Env var indicating we are in Cloud Build.</summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.EnvVars.ApplicationInsightsIngestionTokenEnvVar">
-            <summary>
-            Holds the name of the env var to get an application insights ingestion token.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.EnvVars.ApplicationInsightsIngestionTokenRegKeyPath">
-            <summary>
-            Holds the path of the registry key to get an application insights ingestion token.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.EnvVars.ApplicationInsightsIngestionTokenRegKeyName">
-            <summary>
-            Holds the name of the registry key to get an application insights ingestion token.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.EnvVars.Config">
-            <summary>
-            Holds the name of the env var to get a config file from.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.EnvVars.NoUser">
-            <summary>
-            Name of the env var used to disable Public Client Authentication.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.EnvVars.SystemAccessToken">
-            <summary>
-            Name of the env var for the Azure DevOps pipelines default personal access token.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.EnvVars.AdoPat">
-            <summary>
-            Name of the env var to check for an Azure DevOps personal access token.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.EnvVars.CorextNonInteractive">
-            <summary>
-            Name of the env var used to disable user based authentication modes.
-            NOTE: This is a private variable and it is recommended to not rely on this variable.
-            </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter">
-            <summary>
-            The exception list to string converter.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.Execute(System.Collections.Generic.IEnumerable{System.Exception})">
-            <summary>
-            Executes the convertion of exceptions to a JSON string.
-            </summary>
-            <param name="exceptions">List of exceptions.</param>
-            <returns>JSON format of exception list.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException">
-            <summary>
-            CustomException class with only select properties of Exception class.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException.#ctor(System.Exception)">
-            <summary>
-            Initializes a new instance of the <see cref="T:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException"/> class.
-            </summary>
-            <param name="exception">Exception.</param>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException.#ctor">
-            <summary>
-            Initializes a new instance of the <see cref="T:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException"/> class without intitializing the properties.
-            </summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException.Message">
-            <summary>Gets or sets Message.</summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException.InnerException">
-            <summary>Gets or sets InnerException.</summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException.ExceptionType">
-            <summary>Gets or sets Type.</summary>
-            Note: This property is intentionally made of type `string` instead of `System.Type`.
-            This is because `System.Type` instances cannot be serialized using `System.text.JSONSerializer` for security reasons.
-            For more information, see https://learn.microsoft.com/en-us/dotnet/framework/data/adonet/dataset-datatable-dataview/security-guidance
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException.AADErrorCode">
-            <summary>Gets or Sets AADErrorCode.</summary>
-        </member>
-        <member name="P:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException.CorrelationId">
-            <summary>Gets or Sets CorrelationIds.</summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException.SetAADErrorCode(System.Exception)">
-            <summary>
-            Sets the error code.
-            </summary>
-            <param name="exception">Exception from which error code is extracted.</param>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.ExceptionListToStringConverter.SerializableException.SetCorrelationID(System.Exception)">
-            <summary>
-            Extracts correlation ID from the exception.
-            </summary>
-            <param name="exception">exception from which correlation IDs are extracted.</param>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.IEnvExtensions">
-            <summary>
-            Extension methods to Lasso's <see cref="T:Microsoft.Office.Lasso.Interfaces.IEnv"/> interface.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.IEnvExtensions.InteractiveAuthDisabled(Microsoft.Office.Lasso.Interfaces.IEnv)">
-            <summary>
-            Determines whether interactive auth is disabled or not.
-            </summary>
-            <param name="env">The <see cref="T:Microsoft.Office.Lasso.Interfaces.IEnv"/> to use to get environment variables.</param>
-            <returns>A boolean to indicate if interactive auth modes should be disabled.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.IPublicClientAuth">
-            <summary>
-            An interface for getting a <see cref="T:Microsoft.Authentication.MSALWrapper.TokenResult"/>.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.IPublicClientAuth.Token(Microsoft.Authentication.MSALWrapper.AuthParameters,System.Collections.Generic.IEnumerable{Microsoft.Authentication.MSALWrapper.AuthMode},System.String,System.String,System.TimeSpan,Microsoft.Office.Lasso.Telemetry.EventData)">
-            <summary>
-            Gets a <see cref="T:Microsoft.Authentication.MSALWrapper.TokenResult"/> using the provided parameters by using Public Client Authentication.
-            </summary>
-            <param name="authParams">The authentication parameters.</param>
-            <param name="authModes">The auth modes to use.</param>
-            <param name="domain">The domain to filter too.</param>
-            <param name="prompt">The prompt hint.</param>
-            <param name="timeout">The timout.</param>
-            <param name="eventData">An eventData to extend with telemetry fields.</param>
-            <returns>A <see cref="T:Microsoft.Authentication.MSALWrapper.TokenResult"/> or null.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.LegalFileChecker">
-            <summary>
-            <see cref="T:Microsoft.Authentication.AzureAuth.LegalFileChecker"/> is a helper class to check if a filename is legal.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.LegalFileChecker.IsValidFilename(System.String)">
-            <summary>
-            Check if the given file name valid.
-            </summary>
-            <param name="filename">the file name.</param>
-            <returns>
-            Whether the file name valid.
-            </returns>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.LegalFileChecker.IsValidAbsoluteFilePath(System.String)">
-            <summary>
-            Check if the given file path is a valid absolute path.
-            </summary>
-            <param name="filePath">the file path.</param>
-            <returns>
-            Whether the file name valid.
-            </returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.OutputMode">
-            <summary>
-            The output mode.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.OutputMode.Status">
-            <summary>
-            The status.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.OutputMode.Token">
-            <summary>
-            The token.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.OutputMode.Json">
-            <summary>
-            The json.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.OutputMode.None">
-            <summary>
-            The none.
-            </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.Program">
-            <summary>
-            The start up program.
-            </summary>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.PromptHint">
-            <summary>
-            Functions for ensuring a prompt hint is displayed with an AzureAuth prefix.
-            </summary>
-        </member>
-        <member name="F:Microsoft.Authentication.AzureAuth.PromptHint.AzureAuth">
-            <summary>
-            Azure Auth Display name for prompt hints.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.PromptHint.Prefixed(System.String)">
-            <summary>
-            Prefix a prompt hint for display.
-            </summary>
-            <param name="prompt">Original supplied prompt hint.</param>
-            <returns>Prefixed prompt hint or our default prefix <see cref="F:Microsoft.Authentication.AzureAuth.PromptHint.AzureAuth"/>.</returns>
-        </member>
-        <member name="T:Microsoft.Authentication.AzureAuth.PublicClientAuth">
-            <summary>
-            A class for handling AAD Token acquisition, results logging, and telemetry collection.
-            </summary>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.PublicClientAuth.#ctor(Microsoft.Extensions.Logging.ILogger,Microsoft.Office.Lasso.Interfaces.IEnv,Microsoft.Office.Lasso.Interfaces.ITelemetryService,Microsoft.Authentication.MSALWrapper.IMsalWrapper)">
-            <summary>
-            Initializes a new instance of the <see cref="T:Microsoft.Authentication.AzureAuth.PublicClientAuth"/> class.
-            </summary>
-            <param name="logger">An <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</param>
-            <param name="env">An <see cref="T:Microsoft.Office.Lasso.Interfaces.IEnv"/>.</param>
-            <param name="telemetryService">An <see cref="T:Microsoft.Office.Lasso.Interfaces.ITelemetryService"/>.</param>
-            <param name="msalWrapper">An <see cref="T:Microsoft.Authentication.MSALWrapper.IMsalWrapper"/>.</param>
-            <exception cref="T:System.ArgumentNullException">All parameters must not be null.</exception>
-        </member>
-        <member name="M:Microsoft.Authentication.AzureAuth.PublicClientAuth.Token(Microsoft.Authentication.MSALWrapper.AuthParameters,System.Collections.Generic.IEnumerable{Microsoft.Authentication.MSALWrapper.AuthMode},System.String,System.String,System.TimeSpan,Microsoft.Office.Lasso.Telemetry.EventData)">
-            <inheritdoc/>
-        </member>
-    </members>
-</doc>