Refactor error handling and improve exception messages across multiple admin commands (#5098)

* Refactor error handling and improve exception messages across multiple admin commands

* Update error message

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: gautamdsheth

src/Commands/Admin/AddTenantRestrictedSearchAllowedList.cs

@@ -36,7 +36,7 @@ protected override void ExecuteCmdlet()
             }
             else
             {
-                throw new ArgumentException("Parameter set cannot be resolved using the specified named parameters.");
+                throw new InvalidOperationException("Parameter set cannot be resolved using the specified named parameters.");
             }
 
             if (_sitelist == null)

src/Commands/Admin/GetContainerTypeConfiguration.cs

@@ -16,7 +16,7 @@ protected override void ExecuteCmdlet()
         {
             if (Identity == Guid.Empty)
             {
-                throw new ArgumentException($"Identity {Identity} value is invalid");
+                throw new PSArgumentException($"Identity cannot be an empty GUID. Please provide a valid non-empty GUID.");
             }
             ClientResult<SPContainerTypeConfigurationProperties> sPOContainerTypeConfigurationByContainerTypeId = Tenant.GetSPOContainerTypeConfigurationByContainerTypeId(Identity);
             AdminContext.ExecuteQueryRetry();

src/Commands/Admin/GetStorageEntity.cs

@@ -90,7 +90,7 @@ protected override void ExecuteCmdlet()
             {
                 var storageEntitiesDict = JsonSerializer.Deserialize<Dictionary<string, Dictionary<string, string>>>(storageEntitiesIndex);
 
-                var storageEntities = new List<StorageEntity>();
+                var storageEntities = new List<StorageEntity>(storageEntitiesDict.Count);
                 foreach (var key in storageEntitiesDict.Keys)
                 {
                     var storageEntity = new StorageEntity

src/Commands/Admin/GetTenantDeletedSite.cs

@@ -37,7 +37,7 @@ protected override void ExecuteCmdlet()
             bool flag = Identity != null && !string.IsNullOrEmpty(Identity.Url) && UrlUtilities.IsPersonalSiteUrl(Identity.Url);
             if (Identity == null || string.IsNullOrEmpty(Identity.Url) || flag)
             {
-                List<DeletedSiteProperties> list = new List<DeletedSiteProperties>();
+                List<DeletedSiteProperties> list = [];
                 uint siteRowLimit = Limit;
                 bool flag2 = siteRowLimit == 0;
                 bool flag3 = false;
@@ -95,7 +95,7 @@ private bool RequestDeletedSitePropertiesFromSharePoint(Func<string, SPODeletedS
                     SPODeletedSitePropertiesEnumerable spoDeletedSitePropertiesEnumerable = getDeletedSitePropertiesFunc(text);
                     if (spoDeletedSitePropertiesEnumerable == null)
                     {
-                        throw new ArgumentNullException("Something went wrong fetching deleted sites");
+                        throw new InvalidOperationException("Failed to retrieve deleted sites from SharePoint Online");
                     }
                     AdminContext.Load(spoDeletedSitePropertiesEnumerable);
                     AdminContext.Load(spoDeletedSitePropertiesEnumerable, (SPODeletedSitePropertiesEnumerable sp) => sp.NextStartIndexFromSharePoint);
@@ -146,7 +146,7 @@ private bool RequestDeletedSiteProperties(Func<int, SPODeletedSitePropertiesEnum
                 AdminContext.ExecuteQueryRetry();
                 if (spoDeletedSitePropertiesEnumerable == null)
                 {
-                    throw new ArgumentNullException("Something went wrong fetching deleted sites");
+                    throw new InvalidOperationException("Failed to retrieve deleted sites from SharePoint Online");
                 }
                 checked
                 {

src/Commands/Admin/RemoveTenantSite.cs

@@ -39,7 +39,7 @@ protected override void ExecuteCmdlet()
                 dodelete = ShouldContinue("You are trying to delete the root site collection. Be aware that you need to contact Office 365 Support in order to create a new root site collection. Also notice that some CSOM and REST operations require the root site collection to be present. Removing this site can affect all your remote processing code, even when accessing non-root site collections.", Resources.Confirm);
             }
 
-            if (dodelete && (Force || ShouldContinue(string.Format(Resources.RemoveSiteCollection0, Url), Resources.Confirm)))
+            if (dodelete && (Force || ShouldContinue($"Remove site collection '{Url}'?", Resources.Confirm)))
             {
 
                 Func<TenantOperationMessage, bool> timeoutFunction = TimeoutFunction;

src/Commands/Admin/RemoveTenantSyncClientRestriction.cs

@@ -13,7 +13,7 @@ protected override void ExecuteCmdlet()
         {
             Tenant.IsUnmanagedSyncClientForTenantRestricted = false;
             Tenant.BlockMacSync = false;
-            Tenant.ExcludedFileExtensionsForSyncClient = new List<string>();
+            Tenant.ExcludedFileExtensionsForSyncClient = [];
             Tenant.OptOutOfGrooveBlock = false;
             Tenant.OptOutOfGrooveSoftBlock = false;
             Tenant.DisableReportProblemDialog = false;

src/Commands/Admin/SetTenant.cs

@@ -1690,7 +1690,7 @@ protected override void ExecuteCmdlet()
                 else
                 {
                     // Build a GUID array by resolving each provided site URL to its SiteProperties and extracting the Id
-                    var siteIdList = new List<Guid>();
+                    var siteIdList = new List<Guid>(KnowledgeAgentSelectedSitesList.Length);
                     var tenantForLookup = new Tenant(AdminContext);
 
                     foreach (var siteUrl in KnowledgeAgentSelectedSitesList)

src/Commands/Admin/SetTenantSyncClientRestriction.cs

@@ -68,7 +68,7 @@ protected override void ExecuteCmdlet()
                         break;
 
                     default:
-                        throw new PSArgumentException(string.Format(Resources.GrooveBlockOptionNotSupported, nameof(GrooveBlockOption), GrooveBlockOption), nameof(GrooveBlockOption));
+                        throw new PSArgumentException($"Parameter '{nameof(GrooveBlockOption)}' does not support value '{GrooveBlockOption}'. Supported values are: OptOut, HardOptin, SoftOptin", nameof(GrooveBlockOption));
                 }
             }
             AdminContext.ExecuteQueryRetry();

src/Commands/Apps/GetApplicationCustomizer.cs

@@ -27,7 +27,7 @@ public class GetApplicationCustomizer : PnPWebRetrievalsCmdlet<UserCustomAction>
 
         protected override void ExecuteCmdlet()
         {
-            List<UserCustomAction> actions = new List<UserCustomAction>();
+            List<UserCustomAction> actions = [];
 
             if (Scope == CustomActionScope.All || Scope == CustomActionScope.Web)
             {

src/Commands/Apps/GetAzureADAppSitePermission.cs

@@ -54,7 +54,7 @@ protected override void ExecuteCmdlet()
                     var permissions = this.GraphRequestHelper.GetResultCollection<AzureADAppPermissionInternal>($"v1.0/sites/{siteId}/permissions?$select=Id");
                     if (permissions.Any())
                     {
-                        var results = new List<AzureADAppPermission>();
+                        var results = new List<AzureADAppPermission>(permissions.Count());
                         foreach (var permission in permissions)
                         {
                             // Request the permission individually so it will include the roles