Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Az.Accounts XML Comments #18663

Merged
merged 1 commit into from
Jun 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/Accounts/Authentication.ResourceManager/AzureRmProfile.cs
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,7 @@ public AzureRmProfile()
/// Initializes a new instance of AzureRMProfile and loads its content from specified path.
/// </summary>
/// <param name="path">The location of profile file on disk.</param>
/// <param name="shouldRefreshContextsFromCache"></param>
public AzureRmProfile(string path, bool shouldRefreshContextsFromCache = true) : this()
{
this.ShouldRefreshContextsFromCache = shouldRefreshContextsFromCache;
Expand Down Expand Up @@ -267,6 +268,7 @@ public void Save()
/// Writes profile to a specified path.
/// </summary>
/// <param name="path">File path on disk to save profile to</param>
/// <param name="serializeCache"></param>
public void Save(string path, bool serializeCache = true)
{
if (string.IsNullOrEmpty(path))
Expand All @@ -284,6 +286,7 @@ public void Save(string path, bool serializeCache = true)
/// Writes the profile using the specified file provider
/// </summary>
/// <param name="provider">The file provider used to save the profile</param>
/// <param name="serializeCache"></param>
public void Save(IFileProvider provider, bool serializeCache = true)
{
foreach (string env in AzureEnvironment.PublicEnvironments.Keys)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,7 @@ public PSAzureContext(PSObject other)
public IAzureTenant Tenant { get; set; }

/// <summary>
/// Moved to <see cref="IClientApplicationBase.ClientTokenCache"> due to MSAL.
/// See <see cref="AuthenticationClientFactory"> for how to create client applications.
/// Moved to <see cref="TokenCache"/> due to MSAL.
/// </summary>
public IAzureTokenCache TokenCache { get; set; } = null;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public PSAzureSubscriptionPolicy()
/// <summary>
/// object constructor
/// </summary>
/// <param name="azureSubscriptionPolicies">Json string to convert</param>
/// <param name="subscriptionPolicies">Json string to convert</param>
public PSAzureSubscriptionPolicy(SubscriptionPolicies subscriptionPolicies)
{
if (subscriptionPolicies != null)
Expand Down
1 change: 1 addition & 0 deletions src/Accounts/Authentication/AdalLogger.cs
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ internal static void Disable(AdalLogger logger)
/// </summary>
/// <param name="level">The log level</param>
/// <param name="message">The log message</param>
/// <param name="containsPII"></param>
public void Log(LogLevel level, string message, bool containsPII)
{
foreach (var logger in _loggers)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public interface IClaimsChallengeProcessor
/// <param name="request">The origin request that responds with a claim challenge</param>
/// <param name="claimsChallenge">Claims challenge string</param>
/// <param name="cancellationToken">Cancelation token</param>
/// <returns>Successful or not
/// <returns>Successful or not</returns>
ValueTask<bool> OnClaimsChallenageAsync(HttpRequestMessage request, string claimsChallenge, CancellationToken cancellationToken);
}
}
4 changes: 3 additions & 1 deletion src/Accounts/Authentication/ClaimsChallengeHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ public virtual object Clone()
/// Executed in the event a 401 response with a WWW-Authenticate authentication challenge header is received after the initial request.
/// </summary>
/// <remarks>This implementation handles common authentication challenges such as claims challenges. Service client libraries may derive from this and extend to handle service specific authentication challenges.</remarks>
/// <param name="message">The HttpMessage to be authenticated.</param>
/// <param name="requestMessage">The HttpMessage to be authenticated.</param>
/// <param name="cancellationToken"></param>
/// <param name="responseMessage"></param>
/// <returns>A boolean indicated whether the request should be retried</returns>
protected virtual async Task<bool> OnChallengeAsync(HttpRequestMessage requestMessage, HttpResponseMessage responseMessage, CancellationToken cancellationToken)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ internal class ConfigurationBuilder : IConfigurationBuilder
/// <summary>
/// Adds a new configuration source.
/// </summary>
/// <param name="id"></param>
/// <param name="source">The configuration source to add.</param>
/// <returns>The same <see cref="IConfigurationBuilder"/>.</returns>
public IConfigurationBuilder Add(string id, IConfigurationSource source)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ internal static class ConfigurationExtensions
/// Adds a new configuration source.
/// </summary>
/// <param name="builder">The <see cref="IConfigurationBuilder"/> to add to.</param>
/// <param name="id"></param>
/// <param name="configureSource">Configures the source secrets.</param>
/// <returns>The <see cref="IConfigurationBuilder"/>.</returns>
public static IConfigurationBuilder Add<TSource>(this IConfigurationBuilder builder, string id, Action<TSource> configureSource) where TSource : IConfigurationSource, new()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ internal interface IConfigurationBuilder
/// <summary>
/// Adds a new configuration source.
/// </summary>
/// <param name="id"></param>
/// <param name="source">The configuration source to add.</param>
/// <returns>The same <see cref="IConfigurationBuilder"/>.</returns>
IConfigurationBuilder Add(string id, IConfigurationSource source);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ internal interface IConfigurationSource
/// Builds the <see cref="IConfigurationProvider"/> for this source.
/// </summary>
/// <param name="builder">The <see cref="IConfigurationBuilder"/>.</param>
/// <param name="id"></param>
/// <returns>An <see cref="IConfigurationProvider"/></returns>
IConfigurationProvider Build(IConfigurationBuilder builder, string id);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ internal static class JsonConfigurationExtensions
/// Adds a JSON configuration source to <paramref name="builder"/>.
/// </summary>
/// <param name="builder">The <see cref="IConfigurationBuilder"/> to add to.</param>
/// <param name="id"></param>
/// <param name="stream">The <see cref="Stream"/> to read the json configuration data from.</param>
/// <returns>The <see cref="IConfigurationBuilder"/>.</returns>
public static IConfigurationBuilder AddJsonStream(this IConfigurationBuilder builder, string id, Stream stream)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ internal class JsonStreamConfigurationSource : StreamConfigurationSource
/// Builds the <see cref="JsonStreamConfigurationProvider"/> for this source.
/// </summary>
/// <param name="builder">The <see cref="IConfigurationBuilder"/>.</param>
/// <param name="id"></param>
/// <returns>An <see cref="JsonStreamConfigurationProvider"/></returns>
public override IConfigurationProvider Build(IConfigurationBuilder builder, string id)
=> new JsonStreamConfigurationProvider(this, id);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ internal abstract class StreamConfigurationProvider : ConfigurationProvider
/// Constructor.
/// </summary>
/// <param name="source">The source.</param>
/// <param name="id"></param>
public StreamConfigurationProvider(StreamConfigurationSource source, string id) : base(id)
{
Source = source ?? throw new ArgumentNullException(nameof(source));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ internal abstract class StreamConfigurationSource : IConfigurationSource
/// Builds the <see cref="StreamConfigurationProvider"/> for this source.
/// </summary>
/// <param name="builder">The <see cref="IConfigurationBuilder"/>.</param>
/// <param name="id"></param>
/// <returns>An <see cref="IConfigurationProvider"/></returns>
public abstract IConfigurationProvider Build(IConfigurationBuilder builder, string id);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ internal class UnsettableMemoryConfigurationProvider : ConfigurationProvider, IE
/// Initialize a new instance from the source.
/// </summary>
/// <param name="source">The source settings.</param>
/// <param name="id"></param>
public UnsettableMemoryConfigurationProvider(UnsettableMemoryConfigurationSource source, string id): base(id)
{
if (source == null)
Expand Down
2 changes: 1 addition & 1 deletion src/Accounts/Authenticators/Identity/ITokenCacheOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public class TokenCachePersistenceOptions

/// <summary>
/// If set to true the token cache may be persisted as an unencrypted file if no OS level user encryption is available. When set to false the token cache
/// will throw a <see cref="CredentialUnavailableException"/> in the event no OS level user encryption is available.
/// will throw a <see cref="UnsafeAllowUnencryptedStorage"/>
/// </summary>
public bool UnsafeAllowUnencryptedStorage { get; set; }
}
Expand Down