Skip to content

Commit

Permalink
Fix Az.Accounts XML Comments (#18692)
Browse files Browse the repository at this point in the history
  • Loading branch information
ziyuezh576 authored Jun 24, 2022
1 parent f8a293b commit 5160afe
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 7 deletions.
4 changes: 2 additions & 2 deletions src/Accounts/Authentication.ResourceManager/AzureRmProfile.cs
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +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>
/// <param name="serializeCache">true if the TokenCache should be serialized, false otherwise</param>
public void Save(string path, bool serializeCache = true)
{
if (string.IsNullOrEmpty(path))
Expand All @@ -286,7 +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>
/// <param name="serializeCache">true if the TokenCache should be serialized, false otherwise</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 @@ -163,9 +163,6 @@ public PSAzureContext(PSObject other)
[Ps1Xml(Label = "TenantId", Target = ViewControl.Table, ScriptBlock = "$_.Tenant.ToString()", Position = 4)]
public IAzureTenant Tenant { get; set; }

/// <summary>
/// Moved to <see cref="TokenCache"/> due to MSAL.
/// </summary>
public IAzureTokenCache TokenCache { get; set; } = null;

public string VersionProfile { get; set; }
Expand Down
2 changes: 1 addition & 1 deletion src/Accounts/Authentication/ClaimsChallengeHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public virtual object Clone()
/// </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="requestMessage">The HttpMessage to be authenticated.</param>
/// <param name="cancellationToken"></param>
/// <param name="cancellationToken">Cancelation token</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
4 changes: 3 additions & 1 deletion src/Accounts/Authenticators/Identity/ITokenCacheOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
// ----------------------------------------------------------------------------------
//

using Azure.Identity;

namespace Microsoft.Azure.PowerShell.Authenticators.Identity
{
/// <summary>
Expand All @@ -27,7 +29,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="UnsafeAllowUnencryptedStorage"/>
/// will throw a <see cref="CredentialUnavailableException"/> in the event no OS level user encryption is available.
/// </summary>
public bool UnsafeAllowUnencryptedStorage { get; set; }
}
Expand Down

0 comments on commit 5160afe

Please sign in to comment.