Feature #3517: Refactor code to use confirm message (#4456)

* Feature #3517: Refactor code to use confirm message

* Update docs for cmdlets

---------

Co-authored-by: Gautam Sheth <gautam.sheth@staffbase.com>

Author: gautamdsheth

documentation/Remove-PnPAvailableSiteClassification.md

@@ -58,7 +58,7 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Confirm
+### -Force
 If provided or set to $true, a confirmation will be asked before the actual remove takes place. If omitted or set to $false, it will remove the site classification(s) without asking for confirmation.
 
 ```yaml

documentation/Remove-PnPUser.md

@@ -47,27 +47,13 @@ Remove the user with e-mail address user@tenant.onmicrosoft.com from the User In
 
 ### EXAMPLE 4
 ```powershell
-Remove-PnPUser -Identity i:0#.f|membership|user@tenant.onmicrosoft.com -Confirm:$false
+Remove-PnPUser -Identity i:0#.f|membership|user@tenant.onmicrosoft.com -Force:$false
 ```
 
 Remove the user with LoginName i:0#.f|membership|user@tenant.onmicrosoft.com from the User Information List of the current site collection without asking to confirm the removal first
 
 ## PARAMETERS
 
-### -Confirm
-Specifying the Confirm parameter will allow the confirmation question to be skipped
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -Connection
 Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
 
@@ -110,8 +96,6 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-
-
 ## RELATED LINKS
 
 [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)

src/Commands/Admin/NewSdnProvider.cs

@@ -4,7 +4,7 @@
 
 namespace PnP.PowerShell.Commands.Admin
 {
-    [Cmdlet(VerbsCommon.New, "PnPSdnProvider", SupportsShouldProcess = true)]
+    [Cmdlet(VerbsCommon.New, "PnPSdnProvider")]
     public class NewSdnProvider : PnPAdminCmdlet
     {
         [Parameter(Mandatory = true)]
@@ -15,9 +15,9 @@ public class NewSdnProvider : PnPAdminCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            if (ShouldProcess("Adds a new SDN Provider"))
+            if (ShouldContinue("Add a new SDN Provider", Properties.Resources.Confirm))
             {
-                this.Tenant.AddSdnProvider(Identity, License);
+                Tenant.AddSdnProvider(Identity, License);
                 AdminContext.ExecuteQueryRetry();
             }
         }

src/Commands/Admin/RemoveExternalUser.cs

@@ -15,7 +15,7 @@ protected override void ExecuteCmdlet()
             var office365Tenant = new Office365Tenant(AdminContext);
 
             var results = office365Tenant.RemoveExternalUsers(UniqueIDs);
-            if (this.ShouldProcess(nameof(UniqueIDs), "Remove External Users"))
+            if (ShouldContinue("Remove External Users ?", Properties.Resources.Confirm))
             {
                 var resultObject = new PSObject();
                 AdminContext.Load(results);

src/Commands/Admin/RemoveSdnProvider.cs

@@ -4,14 +4,14 @@
 
 namespace PnP.PowerShell.Commands.Admin
 {
-    [Cmdlet(VerbsCommon.Remove, "PnPSdnProvider", SupportsShouldProcess = true)]
+    [Cmdlet(VerbsCommon.Remove, "PnPSdnProvider")]
     public class RemoveSdnProvider : PnPAdminCmdlet
     {
         protected override void ExecuteCmdlet()
         {
-            if (ShouldProcess("Removes a SDN Provider"))
+            if (ShouldContinue("Removes a SDN Provider", Properties.Resources.Confirm))
             {
-                this.Tenant.RemoveSdnProvider();
+                Tenant.RemoveSdnProvider();
                 AdminContext.ExecuteQueryRetry();
             }
         }

src/Commands/Admin/RepairSite.cs

@@ -1,10 +1,10 @@
 using Microsoft.SharePoint.Client;
 using PnP.PowerShell.Commands.Base;
-using System.Management.Automation;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 using System;
-using System.Text;
 using System.Collections.Generic;
+using System.Management.Automation;
+using System.Text;
 
 namespace PnP.PowerShell.Commands.Admin
 {
@@ -39,7 +39,7 @@ protected override void ExecuteCmdlet()
             {
                 builder.Append($", RuleId {RuleId}");
             }
-            if (this.ShouldProcess(builder.ToString()))
+            if (ShouldContinue(builder.ToString(), Properties.Resources.Confirm))
             {
                 var result = new PSObject();
                 result.Properties.Add(new PSNoteProperty("SiteUrl", site.Url));

src/Commands/Admin/RevokeUserSession.cs

@@ -5,15 +5,15 @@
 
 namespace PnP.PowerShell.Commands.Admin
 {
-    [Cmdlet(VerbsSecurity.Revoke, "PnPUserSession", SupportsShouldProcess = true)]
+    [Cmdlet(VerbsSecurity.Revoke, "PnPUserSession")]
     public class RevokeUserSession : PnPAdminCmdlet
     {
         [Parameter(Mandatory = true)]
         [ValidateNotNull]
         public string User;
         protected override void ExecuteCmdlet()
         {
-            if (ShouldProcess($"Sign out user {User} from all devices"))
+            if (ShouldContinue($"Sign out user {User} from all devices ?", Properties.Resources.Confirm))
             {
                 var office365Tenant = new Office365Tenant(AdminContext);
 

src/Commands/Admin/SetHomeSite.cs

@@ -30,7 +30,7 @@ protected override void ExecuteCmdlet()
 
             if (Tenant.IsMultipleVivaConnectionsFlightEnabled)
             {
-                if (Force.IsPresent || ShouldContinue("Before you update a home site or Viva Connections experiences, make sure you review the documentation at https://aka.ms/homesites. Continue?", string.Empty))
+                if (Force || ShouldContinue("Before you update a home site or Viva Connections experiences, make sure you review the documentation at https://aka.ms/homesites.", Properties.Resources.Confirm))
                 {
                     IEnumerable<TargetedSiteDetails> enumerable = Tenant.GetTargetedSitesDetails()?.Where((TargetedSiteDetails hs) => !hs.IsVivaBackendSite);
                     AdminContext.ExecuteQueryRetry();
@@ -61,9 +61,9 @@ protected override void ExecuteCmdlet()
                     WriteObject(clientResult.Value);
                 }
             }
-            else if (Force.IsPresent || ShouldContinue("Before you set a Home site, make sure you review the documentation at https://aka.ms/homesites. Continue?", string.Empty))
+            else if (Force || ShouldContinue("Before you set a Home site, make sure you review the documentation at https://aka.ms/homesites.", Properties.Resources.Confirm))
             {
-                Tenant.ValidateVivaHomeParameterExists(VivaConnectionsDefaultStart);                
+                Tenant.ValidateVivaHomeParameterExists(VivaConnectionsDefaultStart);
                 HomeSiteConfigurationParam configuration = null;
                 if (VivaConnectionsDefaultStart || DraftMode)
                 {
@@ -78,7 +78,7 @@ protected override void ExecuteCmdlet()
                 ClientResult<string> clientResult = Tenant.SetSPHSiteWithConfiguration(HomeSiteUrl, configuration);
                 AdminContext.ExecuteQueryRetry();
                 WriteObject(clientResult.Value);
-            }            
+            }
         }
 
         private static bool IsSameSiteUrl(string url1, string url2)

src/Commands/Admin/SetSiteArchiveState.cs

@@ -32,7 +32,7 @@ protected override void ExecuteCmdlet()
                     {
                         WriteObject("The site and its contents cannot be accessed when a site is archived. The site needs to be reactivated if it needs to be accessed. Archived sites can be reactivated instantaneously, without any additional charges within 7 days of the action. After 7 days, reactivations will be charged as per Microsoft 365 Archive Billing, and will take time.");
 
-                        if (Force || ShouldProcess(Identity.Url))
+                        if (Force || ShouldContinue(Identity.Url, Properties.Resources.Confirm))
                         {
                             spoOperation = Tenant.ArchiveSiteByUrl(Identity.Url);
                             AdminContext.Load(spoOperation);
@@ -52,7 +52,7 @@ protected override void ExecuteCmdlet()
                             case "FullyArchived":
                                 {
                                     WriteWarning("Reactivating a site from \"Archived\" state is a paid operation. It can take upto 24hrs for the site to be reactivated. Performing the operation \"Reactivate Archived site\" on target.");
-                                    if (Force || ShouldProcess(Identity.Url))
+                                    if (Force || ShouldContinue(Identity.Url, Properties.Resources.Confirm))
                                     {
                                         spoOperation = Tenant.UnarchiveSiteByUrl(Identity.Url);
                                         AdminContext.Load(spoOperation);
@@ -65,7 +65,7 @@ protected override void ExecuteCmdlet()
                                 {
                                     string resourceString = "Reactivating a site from \"Recently Archived\" state is free. Site will be available as an Active site soon.";
                                     WriteObject(resourceString);
-                                    if (Force || ShouldProcess(Identity.Url))
+                                    if (Force || ShouldContinue(Identity.Url, Properties.Resources.Confirm))
                                     {
                                         spoOperation = Tenant.UnarchiveSiteByUrl(Identity.Url);
                                         AdminContext.Load(spoOperation);

src/Commands/Admin/TestSite.cs

@@ -1,10 +1,10 @@
 using Microsoft.SharePoint.Client;
 using PnP.PowerShell.Commands.Base;
-using System.Management.Automation;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 using System;
-using System.Text;
 using System.Collections.Generic;
+using System.Management.Automation;
+using System.Text;
 
 namespace PnP.PowerShell.Commands.Admin
 {
@@ -28,7 +28,7 @@ protected override void ExecuteCmdlet()
                 siteUrl = Identity.Url;
             }
 
-            var site = this.Tenant.GetSiteByUrl(siteUrl);
+            var site = Tenant.GetSiteByUrl(siteUrl);
             AdminContext.Load(site);
             AdminContext.ExecuteQueryRetry();
 
@@ -39,7 +39,7 @@ protected override void ExecuteCmdlet()
             {
                 builder.Append($", RuleId {RuleId}");
             }
-            if (this.ShouldProcess(builder.ToString()))
+            if (ShouldContinue(builder.ToString(), Properties.Resources.Confirm))
             {
                 var result = new PSObject();
                 result.Properties.Add(new PSNoteProperty("SiteUrl", site.Url));