Update Invoke-SetupAction and Complete-SqlDscImage to require SqlSvcAccount parameter and adjust examples

Author: johlju

source/Private/Invoke-SetupAction.ps1

@@ -406,7 +406,7 @@
         Prepares the server for using the database engine for an instance named 'MyInstance'.
 
     .EXAMPLE
-        Invoke-SetupAction -CompleteImage -AcceptLicensingTerms -InstanceId 'MSSQLSERVER' -MediaPath 'E:\'
+        Invoke-SetupAction -CompleteImage -AcceptLicensingTerms -InstanceId 'MSSQLSERVER' -SqlSvcAccount 'NT Service\MSSQLSERVER' -MediaPath 'E:\'
 
         Completes install on a server that was previously prepared (by using prepare image).
 
@@ -1013,7 +1013,7 @@ function Invoke-SetupAction
 
         [Parameter(ParameterSetName = 'Install')]
         [Parameter(ParameterSetName = 'InstallRole')]
-        [Parameter(ParameterSetName = 'CompleteImage')]
+        [Parameter(ParameterSetName = 'CompleteImage', Mandatory = $true)]
         [Parameter(ParameterSetName = 'InstallFailoverCluster')]
         [Parameter(ParameterSetName = 'PrepareFailoverCluster')]
         [Parameter(ParameterSetName = 'AddNode')]

source/Public/Complete-SqlDscImage.ps1

@@ -161,7 +161,7 @@
         None.
 
     .EXAMPLE
-        Complete-SqlDscImage -AcceptLicensingTerms -MediaPath 'E:\' -InstanceId 'MSSQLSERVER'
+        Complete-SqlDscImage -AcceptLicensingTerms -MediaPath 'E:\' -InstanceId 'MSSQLSERVER' -SqlSvcAccount 'NT Service\MSSQLSERVER'
 
         Completes the image installation of the SQL Server default instance that
         was prepared using `Install-SqlDscServer` with the parameter `-PrepareImage`.
@@ -270,7 +270,7 @@ function Complete-SqlDscImage
         [System.String]
         $SqlCollation,
 
-        [Parameter()]
+        [Parameter(Mandatory = $true)]
         [System.String]
         $SqlSvcAccount,
 

tests/Unit/Private/Invoke-SetupAction.Tests.ps1

@@ -82,7 +82,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
         @{
             MockParameterSetName = 'CompleteImage'
             # cSpell: disable-next
-            MockExpectedParameters = '-CompleteImage -AcceptLicensingTerms -MediaPath <string> -InstanceId <string> [-InstanceName <string>] [-Enu] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-ProductKey <string>] [-AgtSvcAccount <string>] [-AgtSvcPassword <securestring>] [-AgtSvcStartupType <string>] [-BrowserSvcStartupType <string>] [-EnableRanU] [-InstallSqlDataDir <string>] [-SqlBackupDir <string>] [-SecurityMode <string>] [-SAPwd <securestring>] [-SqlCollation <string>] [-SqlSvcAccount <string>] [-SqlSvcPassword <securestring>] [-SqlSvcStartupType <string>] [-SqlSysAdminAccounts <string[]>] [-SqlTempDbDir <string>] [-SqlTempDbLogDir <string>] [-SqlTempDbFileCount <ushort>] [-SqlTempDbFileSize <ushort>] [-SqlTempDbFileGrowth <ushort>] [-SqlTempDbLogFileSize <ushort>] [-SqlTempDbLogFileGrowth <ushort>] [-SqlUserDbDir <string>] [-SqlUserDbLogDir <string>] [-FileStreamLevel <ushort>] [-FileStreamShareName <string>] [-NpEnabled] [-TcpEnabled] [-RsInstallMode <string>] [-RSSvcAccount <string>] [-RSSvcPassword <securestring>] [-RSSvcStartupType <string>] [-ProductCoveredBySA] [-Timeout <uint>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
+            MockExpectedParameters = '-CompleteImage -AcceptLicensingTerms -MediaPath <string> -InstanceId <string> -SqlSvcAccount <string> [-InstanceName <string>] [-Enu] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-ProductKey <string>] [-AgtSvcAccount <string>] [-AgtSvcPassword <securestring>] [-AgtSvcStartupType <string>] [-BrowserSvcStartupType <string>] [-EnableRanU] [-InstallSqlDataDir <string>] [-SqlBackupDir <string>] [-SecurityMode <string>] [-SAPwd <securestring>] [-SqlCollation <string>] [-SqlSvcPassword <securestring>] [-SqlSvcStartupType <string>] [-SqlSysAdminAccounts <string[]>] [-SqlTempDbDir <string>] [-SqlTempDbLogDir <string>] [-SqlTempDbFileCount <ushort>] [-SqlTempDbFileSize <ushort>] [-SqlTempDbFileGrowth <ushort>] [-SqlTempDbLogFileSize <ushort>] [-SqlTempDbLogFileGrowth <ushort>] [-SqlUserDbDir <string>] [-SqlUserDbLogDir <string>] [-FileStreamLevel <ushort>] [-FileStreamShareName <string>] [-NpEnabled] [-TcpEnabled] [-RsInstallMode <string>] [-RSSvcAccount <string>] [-RSSvcPassword <securestring>] [-RSSvcStartupType <string>] [-ProductCoveredBySA] [-Timeout <uint>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
         }
         @{
             MockParameterSetName = 'Upgrade'
@@ -3227,6 +3227,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                         AcceptLicensingTerms = $true
                         MediaPath = '\SqlMedia'
                         InstanceId = 'MSSQLSERVER'
+                        SqlSvcAccount = 'NT Service\MSSQLSERVER'
                     }
                 }
             }
@@ -3286,6 +3287,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                         AcceptLicensingTerms = $true
                         MediaPath = '\SqlMedia'
                         InstanceId = 'MSSQLSERVER'
+                        SqlSvcAccount = 'NT Service\MSSQLSERVER'
                         Force = $true
                         PBStartPortRange = 16450
                         PBEndPortRange = 16460
@@ -3510,6 +3512,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                         AcceptLicensingTerms = $true
                         MediaPath = '\SqlMedia'
                         InstanceId = 'MSSQLSERVER'
+                        SqlSvcAccount = 'NT Service\MSSQLSERVER'
                         Force = $true
                     }
                 }

tests/Unit/Public/Complete-SqlDscImage.Tests.ps1

@@ -52,7 +52,7 @@ Describe 'Complete-SqlDscImage' -Tag 'Public' {
         @{
             MockParameterSetName   = '__AllParameterSets'
             # cSpell: disable-next
-            MockExpectedParameters = '[-MediaPath] <string> [[-InstanceName] <string>] [-InstanceId] <string> [[-PBEngSvcAccount] <string>] [[-PBEngSvcPassword] <securestring>] [[-PBEngSvcStartupType] <string>] [[-PBStartPortRange] <ushort>] [[-PBEndPortRange] <ushort>] [[-ProductKey] <string>] [[-AgtSvcAccount] <string>] [[-AgtSvcPassword] <securestring>] [[-AgtSvcStartupType] <string>] [[-BrowserSvcStartupType] <string>] [[-InstallSqlDataDir] <string>] [[-SqlBackupDir] <string>] [[-SecurityMode] <string>] [[-SAPwd] <securestring>] [[-SqlCollation] <string>] [[-SqlSvcAccount] <string>] [[-SqlSvcPassword] <securestring>] [[-SqlSvcStartupType] <string>] [[-SqlSysAdminAccounts] <string[]>] [[-SqlTempDbDir] <string>] [[-SqlTempDbLogDir] <string>] [[-SqlTempDbFileCount] <ushort>] [[-SqlTempDbFileSize] <ushort>] [[-SqlTempDbFileGrowth] <ushort>] [[-SqlTempDbLogFileSize] <ushort>] [[-SqlTempDbLogFileGrowth] <ushort>] [[-SqlUserDbDir] <string>] [[-SqlUserDbLogDir] <string>] [[-FileStreamLevel] <ushort>] [[-FileStreamShareName] <string>] [[-RsInstallMode] <string>] [[-RSSvcAccount] <string>] [[-RSSvcPassword] <securestring>] [[-RSSvcStartupType] <string>] [[-Timeout] <uint>] -AcceptLicensingTerms [-Enu] [-PBScaleOut] [-EnableRanU] [-NpEnabled] [-TcpEnabled] [-ProductCoveredBySA] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
+            MockExpectedParameters = '[-MediaPath] <string> [[-InstanceName] <string>] [-InstanceId] <string> [[-PBEngSvcAccount] <string>] [[-PBEngSvcPassword] <securestring>] [[-PBEngSvcStartupType] <string>] [[-PBStartPortRange] <ushort>] [[-PBEndPortRange] <ushort>] [[-ProductKey] <string>] [[-AgtSvcAccount] <string>] [[-AgtSvcPassword] <securestring>] [[-AgtSvcStartupType] <string>] [[-BrowserSvcStartupType] <string>] [[-InstallSqlDataDir] <string>] [[-SqlBackupDir] <string>] [[-SecurityMode] <string>] [[-SAPwd] <securestring>] [[-SqlCollation] <string>] [-SqlSvcAccount] <string> [[-SqlSvcPassword] <securestring>] [[-SqlSvcStartupType] <string>] [[-SqlSysAdminAccounts] <string[]>] [[-SqlTempDbDir] <string>] [[-SqlTempDbLogDir] <string>] [[-SqlTempDbFileCount] <ushort>] [[-SqlTempDbFileSize] <ushort>] [[-SqlTempDbFileGrowth] <ushort>] [[-SqlTempDbLogFileSize] <ushort>] [[-SqlTempDbLogFileGrowth] <ushort>] [[-SqlUserDbDir] <string>] [[-SqlUserDbLogDir] <string>] [[-FileStreamLevel] <ushort>] [[-FileStreamShareName] <string>] [[-RsInstallMode] <string>] [[-RSSvcAccount] <string>] [[-RSSvcPassword] <securestring>] [[-RSSvcStartupType] <string>] [[-Timeout] <uint>] -AcceptLicensingTerms [-Enu] [-PBScaleOut] [-EnableRanU] [-NpEnabled] [-TcpEnabled] [-ProductCoveredBySA] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
         }
     ) {
         $result = (Get-Command -Name 'Complete-SqlDscImage').ParameterSets |
@@ -95,6 +95,7 @@ Describe 'Complete-SqlDscImage' -Tag 'Public' {
                     AcceptLicensingTerms = $true
                     MediaPath            = '\SqlMedia'
                     InstanceId           = 'MSSQLSERVER'
+                    SqlSvcAccount        = 'NT Service\MSSQLSERVER'
                     ErrorAction          = 'Stop'
                 }
             }
@@ -144,6 +145,7 @@ Describe 'Complete-SqlDscImage' -Tag 'Public' {
                     AcceptLicensingTerms = $true
                     MediaPath            = '\SqlMedia'
                     InstanceId           = 'MSSQLSERVER'
+                    SqlSvcAccount        = 'NT Service\MSSQLSERVER'
                     Force                = $true
                     PBStartPortRange     = 16450
                     PBEndPortRange       = 16460
@@ -358,6 +360,7 @@ Describe 'Complete-SqlDscImage' -Tag 'Public' {
                     AcceptLicensingTerms = $true
                     MediaPath            = '\SqlMedia'
                     InstanceId           = 'MSSQLSERVER'
+                    SqlSvcAccount        = 'NT Service\MSSQLSERVER'
                     Force                = $true
                     ErrorAction          = 'Stop'
                 }