Add AgtSvcAccount parameter to Invoke-SetupAction and Complete-SqlDscImage; update examples and tests

johlju · johlju · commit b39e129fe581 · 2025-10-19T18:05:56.000+02:00
diff --git a/source/Private/Invoke-SetupAction.ps1 b/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' -SqlSvcAccount 'NT Service\MSSQLSERVER' -MediaPath 'E:\'
+        Invoke-SetupAction -CompleteImage -AcceptLicensingTerms -InstanceId 'MSSQLSERVER' -SqlSvcAccount 'NT Service\MSSQLSERVER' -AgtSvcAccount 'NT Service\MSSQLSERVER' -MediaPath 'E:\'
 
         Completes install on a server that was previously prepared (by using prepare image).
 
@@ -816,7 +816,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')]
diff --git a/source/Public/Complete-SqlDscImage.ps1 b/source/Public/Complete-SqlDscImage.ps1
@@ -161,7 +161,7 @@
         None.
 
     .EXAMPLE
-        Complete-SqlDscImage -AcceptLicensingTerms -MediaPath 'E:\' -InstanceId 'MSSQLSERVER' -SqlSvcAccount 'NT Service\MSSQLSERVER'
+        Complete-SqlDscImage -AcceptLicensingTerms -MediaPath 'E:\' -InstanceId 'MSSQLSERVER' -SqlSvcAccount 'NT Service\MSSQLSERVER' -AgtSvcAccount 'NT Service\MSSQLSERVER'
 
         Completes the image installation of the SQL Server default instance that
         was prepared using `Install-SqlDscServer` with the parameter `-PrepareImage`.
@@ -227,7 +227,7 @@ function Complete-SqlDscImage
         [System.String]
         $ProductKey, # This is argument PID but $PID is reserved variable.
 
-        [Parameter()]
+        [Parameter(Mandatory = $true)]
         [System.String]
         $AgtSvcAccount,
 
diff --git a/tests/Integration/Commands/Complete-SqlDscImage.Integration.Tests.ps1 b/tests/Integration/Commands/Complete-SqlDscImage.Integration.Tests.ps1
@@ -47,6 +47,8 @@ Describe 'Complete-SqlDscImage' -Tag @('Integration_SQL2017', 'Integration_SQL20
                 InstanceId            = 'DSCSQLTEST'
                 SqlSvcAccount         = '{0}\svc-SqlPrimary' -f $computerName
                 SqlSvcPassword        = ConvertTo-SecureString -String 'yig-C^Equ3' -AsPlainText -Force
+                AgtSvcAccount         = '{0}\svc-SqlAgentPri' -f $computerName
+                AgtSvcPassword        = ConvertTo-SecureString -String 'yig-C^Equ3' -AsPlainText -Force
                 MediaPath             = $env:IsoDrivePath
                 Verbose               = $true
                 ErrorAction           = 'Stop'
@@ -145,6 +147,8 @@ Describe 'Complete-SqlDscImage' -Tag @('Integration_SQL2017', 'Integration_SQL20
                 InstanceId            = 'DSCSQLTEST'
                 SqlSvcAccount         = '{0}\svc-SqlPrimary' -f $computerName
                 SqlSvcPassword        = ConvertTo-SecureString -String 'yig-C^Equ3' -AsPlainText -Force
+                AgtSvcAccount         = '{0}\svc-SqlAgentPri' -f $computerName
+                AgtSvcPassword        = ConvertTo-SecureString -String 'yig-C^Equ3' -AsPlainText -Force
                 SqlSysAdminAccounts   = @(
                     ('{0}\SqlAdmin' -f $computerName)
                 )
diff --git a/tests/Unit/Private/Invoke-SetupAction.Tests.ps1 b/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> -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>]'
+            MockExpectedParameters = '-CompleteImage -AcceptLicensingTerms -MediaPath <string> -InstanceId <string> -AgtSvcAccount <string> -SqlSvcAccount <string> [-InstanceName <string>] [-Enu] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-ProductKey <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'
@@ -3228,6 +3228,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                         MediaPath = '\SqlMedia'
                         InstanceId = 'MSSQLSERVER'
                         SqlSvcAccount = 'NT Service\MSSQLSERVER'
+                        AgtSvcAccount = 'NT Service\MSSQLSERVER'
                     }
                 }
             }
@@ -3288,6 +3289,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                         MediaPath = '\SqlMedia'
                         InstanceId = 'MSSQLSERVER'
                         SqlSvcAccount = 'NT Service\MSSQLSERVER'
+                        AgtSvcAccount = 'NT Service\MSSQLSERVER'
                         Force = $true
                         PBStartPortRange = 16450
                         PBEndPortRange = 16460
@@ -3513,6 +3515,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                         MediaPath = '\SqlMedia'
                         InstanceId = 'MSSQLSERVER'
                         SqlSvcAccount = 'NT Service\MSSQLSERVER'
+                        AgtSvcAccount = 'NT Service\MSSQLSERVER'
                         Force = $true
                     }
                 }
diff --git a/tests/Unit/Public/Complete-SqlDscImage.Tests.ps1 b/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 |
@@ -96,6 +96,7 @@ Describe 'Complete-SqlDscImage' -Tag 'Public' {
                     MediaPath            = '\SqlMedia'
                     InstanceId           = 'MSSQLSERVER'
                     SqlSvcAccount        = 'NT Service\MSSQLSERVER'
+                    AgtSvcAccount        = 'NT Service\MSSQLSERVER'
                     ErrorAction          = 'Stop'
                 }
             }
@@ -146,6 +147,7 @@ Describe 'Complete-SqlDscImage' -Tag 'Public' {
                     MediaPath            = '\SqlMedia'
                     InstanceId           = 'MSSQLSERVER'
                     SqlSvcAccount        = 'NT Service\MSSQLSERVER'
+                    AgtSvcAccount        = 'NT Service\MSSQLSERVER'
                     Force                = $true
                     PBStartPortRange     = 16450
                     PBEndPortRange       = 16460
@@ -361,6 +363,7 @@ Describe 'Complete-SqlDscImage' -Tag 'Public' {
                     MediaPath            = '\SqlMedia'
                     InstanceId           = 'MSSQLSERVER'
                     SqlSvcAccount        = 'NT Service\MSSQLSERVER'
+                    AgtSvcAccount        = 'NT Service\MSSQLSERVER'
                     Force                = $true
                     ErrorAction          = 'Stop'
                 }

Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {`
`82`	`82`	`@{`
`83`	`83`	`MockParameterSetName = 'CompleteImage'`
`84`	`84`	`# cSpell: disable-next`
`85`		- 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>]'
	`85`	+ MockExpectedParameters = '-CompleteImage -AcceptLicensingTerms -MediaPath <string> -InstanceId <string> -AgtSvcAccount <string> -SqlSvcAccount <string> [-InstanceName <string>] [-Enu] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-ProductKey <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>]'
`86`	`86`	`}`
`87`	`87`	`@{`
`88`	`88`	`MockParameterSetName = 'Upgrade'`
`@@ -3228,6 +3228,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {`
`3228`	`3228`	`MediaPath = '\SqlMedia'`
`3229`	`3229`	`InstanceId = 'MSSQLSERVER'`
`3230`	`3230`	`SqlSvcAccount = 'NT Service\MSSQLSERVER'`
	`3231`	`+ AgtSvcAccount = 'NT Service\MSSQLSERVER'`
`3231`	`3232`	`}`
`3232`	`3233`	`}`
`3233`	`3234`	`}`
`@@ -3288,6 +3289,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {`
`3288`	`3289`	`MediaPath = '\SqlMedia'`
`3289`	`3290`	`InstanceId = 'MSSQLSERVER'`
`3290`	`3291`	`SqlSvcAccount = 'NT Service\MSSQLSERVER'`
	`3292`	`+ AgtSvcAccount = 'NT Service\MSSQLSERVER'`
`3291`	`3293`	`Force = $true`
`3292`	`3294`	`PBStartPortRange = 16450`
`3293`	`3295`	`PBEndPortRange = 16460`
`@@ -3513,6 +3515,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {`
`3513`	`3515`	`MediaPath = '\SqlMedia'`
`3514`	`3516`	`InstanceId = 'MSSQLSERVER'`
`3515`	`3517`	`SqlSvcAccount = 'NT Service\MSSQLSERVER'`
	`3518`	`+ AgtSvcAccount = 'NT Service\MSSQLSERVER'`
`3516`	`3519`	`Force = $true`
`3517`	`3520`	`}`
`3518`	`3521`	`}`