Update Invoke-SetupAction documentation to clarify Repair action behavior and remove FEATURES parameter requirement

Author: johlju

CHANGELOG.md

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   [issue #2238](https://github.com/dsccommunity/SqlServerDsc/issues/2238).
 - Added integration tests for `ConvertTo-SqlDscServerPermission` command to ensure
   command reliability [issue #2207](https://github.com/dsccommunity/SqlServerDsc/issues/2207).
+- Added integration tests for `ConvertTo-SqlDscServerPermission` command to ensure
+  command reliability [issue #2207](https://github.com/dsccommunity/SqlServerDsc/issues/2207).
 - Added post-installation configuration integration test to configure SSL certificate
   support for SQL Server instance DSCSQLTEST in CI environment, enabling testing
   of encryption-related functionality. The new `PostInstallationConfiguration`
@@ -70,6 +72,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- `Repair-SqlDscServer`
+  - Removed the `Features` parameter from the command as SQL Server Repair action
+    does not accept the `/FEATURES` parameter. SQL Server automatically repairs
+    all installed features when using the Repair action. This fixes the error
+    "The setting 'FEATURES' is not allowed when the value of setting 'ACTION'
+    is 'Repair'." that occurred when attempting to repair a SQL Server instance
+    [issue #2238](https://github.com/dsccommunity/SqlServerDsc/issues/2238).
 - Corrected error message in test file to recommend 'noop' task instead of 'build'
   task for resolving dependencies
   ([issue #2279](https://github.com/dsccommunity/SqlServerDsc/issues/2279)).

source/Private/Invoke-SetupAction.ps1

@@ -421,9 +421,9 @@
         Upgrades the instance 'MyInstance' with the SQL Server edition that is provided by the media path.
 
     .EXAMPLE
-        Invoke-SetupAction -Repair -InstanceName 'MyInstance' -Features 'SQLENGINE' -MediaPath 'E:\'
+        Invoke-SetupAction -Repair -InstanceName 'MyInstance' -MediaPath 'E:\'
 
-        Repairs the database engine of the instance 'MyInstance'.
+        Repairs all installed features of the instance 'MyInstance'.
 
     .EXAMPLE
         Invoke-SetupAction -RebuildDatabase -InstanceName 'MyInstance' -SqlSysAdminAccounts @('MyAdminAccount') -MediaPath 'E:\'
@@ -462,6 +462,14 @@
 
         For RebuildDatabase the parameter SAPwd must be set if the instance was
         installed with SecurityMode = 'SQL'.
+
+        SQL Server Repair action does not accept the FEATURES parameter. Although
+        Microsoft's documentation lists /FEATURES as required for the Repair action,
+        the actual SQL Server setup executable (tested with SQL Server 2017 and
+        SQL Server 2022) rejects this parameter with the error: "The setting
+        'FEATURES' is not allowed when the value of setting 'ACTION' is 'Repair'."
+        SQL Server automatically repairs all installed features during a repair
+        operation.
 #>
 function Invoke-SetupAction
 {
@@ -626,7 +634,6 @@ function Invoke-SetupAction
 
         [Parameter(ParameterSetName = 'Install', Mandatory = $true)]
         [Parameter(ParameterSetName = 'PrepareImage', Mandatory = $true)]
-        [Parameter(ParameterSetName = 'Repair', Mandatory = $true)]
         [Parameter(ParameterSetName = 'Uninstall', Mandatory = $true)]
         [Parameter(ParameterSetName = 'InstallFailoverCluster', Mandatory = $true)]
         [Parameter(ParameterSetName = 'PrepareFailoverCluster', Mandatory = $true)]

source/Public/Repair-SqlDscServer.ps1

@@ -27,9 +27,6 @@
     .PARAMETER Enu
         See the notes section for more information.
 
-    .PARAMETER Features
-        See the notes section for more information.
-
     .PARAMETER PBEngSvcAccount
         See the notes section for more information.
 
@@ -55,14 +52,22 @@
         None.
 
     .EXAMPLE
-        Repair-SqlDscServer -InstanceName 'MyInstance' -Features 'SQLENGINE' -MediaPath 'E:\'
+        Repair-SqlDscServer -InstanceName 'MyInstance' -MediaPath 'E:\'
 
-        Repairs the database engine of the instance 'MyInstance'.
+        Repairs all installed features of the instance 'MyInstance'.
 
     .NOTES
         The parameters are intentionally not described since it would take a lot
         of effort to keep them up to date. Instead there is a link that points to
         the SQL Server command line setup documentation which will stay relevant.
+
+        SQL Server Repair action does not accept the FEATURES parameter. Although
+        Microsoft's documentation lists /FEATURES as required for the Repair action,
+        the actual SQL Server setup executable (tested with SQL Server 2017 and
+        SQL Server 2022) rejects this parameter with the error: "The setting
+        'FEATURES' is not allowed when the value of setting 'ACTION' is 'Repair'."
+        SQL Server automatically repairs all installed features during a repair
+        operation.
 #>
 function Repair-SqlDscServer
 {
@@ -84,44 +89,6 @@ function Repair-SqlDscServer
         [System.Management.Automation.SwitchParameter]
         $Enu,
 
-        [Parameter(Mandatory = $true)]
-        [ValidateSet(
-            'SQL',
-            'SQLEngine', # Part of parent feature SQL
-            'Replication', # Part of parent feature SQL
-            'FullText', # Part of parent feature SQL
-            'DQ', # Part of parent feature SQL
-            'PolyBase', # Part of parent feature SQL
-            'PolyBaseCore', # Part of parent feature SQL
-            'PolyBaseJava', # Part of parent feature SQL
-            'AdvancedAnalytics', # Part of parent feature SQL
-            'SQL_INST_MR', # Part of parent feature SQL
-            'SQL_INST_MPY', # Part of parent feature SQL
-            'SQL_INST_JAVA', # Part of parent feature SQL
-            'AS',
-            'RS',
-            'RS_SHP',
-            'RS_SHPWFE', # cspell: disable-line
-            'DQC',
-            'IS',
-            'IS_Master', # Part of parent feature IS
-            'IS_Worker', # Part of parent feature IS
-            'MDS',
-            'SQL_SHARED_MPY',
-            'SQL_SHARED_MR',
-            'Tools',
-            'BC', # Part of parent feature Tools
-            'Conn', # Part of parent feature Tools
-            'DREPLAY_CTLR', # Part of parent feature Tools (cspell: disable-line)
-            'DREPLAY_CLT', # Part of parent feature Tools (cspell: disable-line)
-            'SNAC_SDK', # Part of parent feature Tools (cspell: disable-line)
-            'SDK', # Part of parent feature Tools
-            'LocalDB', # Part of parent feature Tools
-            'AZUREEXTENSION'
-        )]
-        [System.String[]]
-        $Features,
-
         [Parameter()]
         [System.String]
         $PBEngSvcAccount,

tests/Integration/Commands/Repair-SqlDscServer.Integration.Tests.ps1

@@ -46,7 +46,6 @@ Describe 'Repair-SqlDscServer' -Tag @('Integration_SQL2017', 'Integration_SQL201
             # Set splatting parameters for Repair-SqlDscServer
             $repairSqlDscServerParameters = @{
                 InstanceName = 'DSCSQLTEST'
-                Features     = 'SQLENGINE'
                 MediaPath    = $env:IsoDrivePath
                 Verbose      = $true
                 ErrorAction  = 'Stop'