Merge branch 'main' into user/haashah/add-no-validate-flag

CHANGELOG.md

@@ -6,7 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
-- `--allow-custom-scopes` to skip validation and allow custom Azure DevOps PAT scopes.
+- Added `--allow-custom-scopes` flag to skip validation and allow custom Azure DevOps PAT scopes.
+- Added new sub-command `azureauth ado pat scopes` to list the set of actual scopes the `pat` command validates against and print the short-link to the pat scopes docs.
 
 ## [0.8.4] - 2023-09-05
 ### Changed

src/AzureAuth/Commands/Ado/CommandPat.cs

@@ -25,6 +25,7 @@ namespace Microsoft.Authentication.AzureAuth.Commands.Ado
     /// An ADO Command for creating or fetching, and returning Azure Devops PATs.
     /// </summary>
     [Command("pat", Description = "Create and cache Azure Devops Personal Access Tokens (PATs) using encrypted local storage.")]
+    [Subcommand(typeof(Pat.CommandScopes))]
     public class CommandPat
     {
         private const string OrganizationOption = "--organization";

src/AzureAuth/Commands/Ado/Pat/CommandScopes.cs

@@ -0,0 +1,48 @@
+
+using McMaster.Extensions.CommandLineUtils;
+
+using Microsoft.Authentication.AdoPat;
+using Microsoft.Extensions.Logging;
+
+using System;
+using System.Linq;
+
+namespace Microsoft.Authentication.AzureAuth.Commands.Ado.Pat
+{
+    /// <summary>
+    /// Command to print the list of available scopes
+
+    /// </summary>
+    [Command("scopes", Description = "List the valid ado pat scopes")]
+    public class CommandScopes
+    {
+        private readonly ILogger logger;
+
+        private readonly string UrlMessage = $"See {AdoPat.Constants.PatListURL} for details.";
+
+        /// <summary>
+        /// Create a CommandScopes
+        /// </summary>
+        /// <param name="logger"></param>
+        public CommandScopes(ILogger<CommandScopes> logger)
+        {
+            this.logger = logger;
+        }
+
+        /// <summary>
+        /// Executes the Scopes command listing the available scopes
+        /// </summary>
+        /// <returns></returns>
+        public int OnExecute()
+        {
+            var scopes = Scopes.ValidScopes.ToList();
+            scopes.Sort();
+
+            // Print URL at the top and bottom because it's a long list of scopes.
+            logger.LogInformation(UrlMessage + "\n");
+            logger.LogInformation(string.Join(Environment.NewLine, scopes));
+            logger.LogInformation("\n" + UrlMessage);
+            return 0;
+        }
+    }
+}