Set-SqlDscRSSmtpConfiguration: Add new command

CHANGELOG.md

@@ -244,6 +244,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   by calling the `InitializeReportServer` CIM method. Used to complete initial
   configuration after database and URL setup
   ([issue #2014](https://github.com/dsccommunity/SqlServerDsc/issues/2014)).
+- Added public command `Set-SqlDscRSSmtpConfiguration` to configure SMTP
+  settings for Reporting Services email delivery. Wraps the `SetEmailConfiguration`
+  CIM method.
 - Added public commands `Set-SqlDscRSUnattendedExecutionAccount` and
   `Remove-SqlDscRSUnattendedExecutionAccount` to manage the unattended execution
   account for Reporting Services. These wrap the `SetUnattendedExecutionAccount`

azure-pipelines.yml

@@ -596,6 +596,7 @@ stages:
                   'tests/Integration/Commands/Post.ServiceAccountChange.SQL2019-2022.RS.Integration.Tests.ps1'
                   # Group 7
                   'tests/Integration/Commands/Set-SqlDscRSUnattendedExecutionAccount.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Set-SqlDscRSSmtpConfiguration.Integration.Tests.ps1'
                   'tests/Integration/Commands/Remove-SqlDscRSUnattendedExecutionAccount.Integration.Tests.ps1'
                   # Group 8
                   'tests/Integration/Commands/Repair-SqlDscReportingService.Integration.Tests.ps1'
@@ -698,6 +699,7 @@ stages:
                   'tests/Integration/Commands/Post.ServiceAccountChange.PowerBI.RS.Integration.Tests.ps1'
                   # Group 7
                   'tests/Integration/Commands/Set-SqlDscRSUnattendedExecutionAccount.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Set-SqlDscRSSmtpConfiguration.Integration.Tests.ps1'
                   'tests/Integration/Commands/Remove-SqlDscRSUnattendedExecutionAccount.Integration.Tests.ps1'
                   # Group 8
                   'tests/Integration/Commands/Repair-SqlDscPowerBIReportServer.Integration.Tests.ps1'
@@ -786,6 +788,7 @@ stages:
                   'tests/Integration/Commands/Set-SqlDscRSSslCertificateBinding.Integration.Tests.ps1'
                   # Group 7
                   'tests/Integration/Commands/Set-SqlDscRSUnattendedExecutionAccount.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Set-SqlDscRSSmtpConfiguration.Integration.Tests.ps1'
                   'tests/Integration/Commands/Remove-SqlDscRSUnattendedExecutionAccount.Integration.Tests.ps1'
               )
             name: test

source/Public/Add-SqlDscRSSslCertificateBinding.ps1

@@ -171,9 +171,9 @@ function Add-SqlDscRSSslCertificateBinding
             }
             catch
             {
-                $errorMessage = $script:localizedData.Add_SqlDscRSSslCertificateBinding_FailedToAdd -f $instanceName, $_.Exception.Message
+                $errorMessage = $script:localizedData.Add_SqlDscRSSslCertificateBinding_FailedToAdd -f $instanceName
 
-                $exception = New-InvalidOperationException -Message $errorMessage -ErrorRecord $_ -PassThru
+                $exception = New-Exception -Message $errorMessage -ErrorRecord $_
 
                 $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'ASRSSCB0001' -ErrorCategory 'InvalidOperation' -TargetObject $Configuration
 

source/Public/Add-SqlDscRSUrlReservation.ps1

@@ -155,9 +155,11 @@ function Add-SqlDscRSUrlReservation
             }
             catch
             {
-                $errorMessage = $script:localizedData.Add_SqlDscRSUrlReservation_FailedToAdd -f $instanceName, $_.Exception.Message
+                $errorMessage = $script:localizedData.Add_SqlDscRSUrlReservation_FailedToAdd -f $instanceName
 
-                $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'ASRUR0001' -ErrorCategory 'InvalidOperation' -TargetObject $Configuration
+                $exception = New-Exception -Message $errorMessage -ErrorRecord $_
+
+                $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'ASRUR0001' -ErrorCategory 'InvalidOperation' -TargetObject $Configuration
 
                 $PSCmdlet.ThrowTerminatingError($errorRecord)
             }

source/Public/Get-SqlDscRSConfigFile.ps1

@@ -139,7 +139,9 @@ function Get-SqlDscRSConfigFile
                 {
                     $errorMessage = $script:localizedData.Get_SqlDscRSConfigFile_InstanceNotFound -f $InstanceName
 
-                    $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSCF0001' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
+                    $exception = New-Exception -Message $errorMessage
+
+                    $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSCF0001' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
 
                     $PSCmdlet.ThrowTerminatingError($errorRecord)
                 }
@@ -148,7 +150,9 @@ function Get-SqlDscRSConfigFile
                 {
                     $errorMessage = $script:localizedData.Get_SqlDscRSConfigFile_ConfigFilePathNotFound -f $InstanceName
 
-                    $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSCF0002' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
+                    $exception = New-Exception -Message $errorMessage
+
+                    $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSCF0002' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
 
                     $PSCmdlet.ThrowTerminatingError($errorRecord)
                 }
@@ -164,7 +168,9 @@ function Get-SqlDscRSConfigFile
                 {
                     $errorMessage = $script:localizedData.Get_SqlDscRSConfigFile_ConfigFilePathNotFound -f $SetupConfiguration.InstanceName
 
-                    $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSCF0002' -ErrorCategory 'ObjectNotFound' -TargetObject $SetupConfiguration.InstanceName
+                    $exception = New-Exception -Message $errorMessage
+
+                    $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSCF0002' -ErrorCategory 'ObjectNotFound' -TargetObject $SetupConfiguration.InstanceName
 
                     $PSCmdlet.ThrowTerminatingError($errorRecord)
                 }
@@ -180,7 +186,9 @@ function Get-SqlDscRSConfigFile
                 {
                     $errorMessage = $script:localizedData.Get_SqlDscRSConfigFile_FileNotFound -f $Path
 
-                    $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSCF0004' -ErrorCategory 'ObjectNotFound' -TargetObject $Path
+                    $exception = New-Exception -Message $errorMessage
+
+                    $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSCF0004' -ErrorCategory 'ObjectNotFound' -TargetObject $Path
 
                     $PSCmdlet.ThrowTerminatingError($errorRecord)
                 }
@@ -197,9 +205,11 @@ function Get-SqlDscRSConfigFile
         }
         catch
         {
-            $errorMessage = $script:localizedData.Get_SqlDscRSConfigFile_FailedToReadConfigFile -f $configFilePath, $_.Exception.Message
+            $errorMessage = $script:localizedData.Get_SqlDscRSConfigFile_FailedToReadConfigFile -f $configFilePath
+
+            $exception = New-Exception -Message $errorMessage -ErrorRecord $_
 
-            $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -ErrorRecord $_ -PassThru) -ErrorId 'GSRSCF0003' -ErrorCategory 'ReadError' -TargetObject $configFilePath
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSCF0003' -ErrorCategory 'ReadError' -TargetObject $configFilePath
 
             $PSCmdlet.ThrowTerminatingError($errorRecord)
         }

source/Public/Get-SqlDscRSConfiguration.ps1

@@ -120,7 +120,9 @@ function Get-SqlDscRSConfiguration
         {
             $errorMessage = $script:localizedData.Get_SqlDscRSConfiguration_InstanceNotFound -f $InstanceName
 
-            $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSCD0001' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
+            $exception = New-Exception -Message $errorMessage
+
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSCD0001' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
 
             $PSCmdlet.ThrowTerminatingError($errorRecord)
         }
@@ -129,7 +131,9 @@ function Get-SqlDscRSConfiguration
         {
             $errorMessage = $script:localizedData.Get_SqlDscRSConfiguration_VersionNotFound -f $InstanceName
 
-            $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSCD0002' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
+            $exception = New-Exception -Message $errorMessage
+
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSCD0002' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
 
             $PSCmdlet.ThrowTerminatingError($errorRecord)
         }
@@ -167,9 +171,11 @@ function Get-SqlDscRSConfiguration
         }
         catch
         {
-            $errorMessage = $script:localizedData.Get_SqlDscRSConfiguration_FailedToGetConfiguration -f $InstanceName, $_.Exception.Message
+            $errorMessage = $script:localizedData.Get_SqlDscRSConfiguration_FailedToGetConfiguration -f $InstanceName
 
-            $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -ErrorRecord $_ -PassThru) -ErrorId 'GSRSCD0003' -ErrorCategory 'InvalidOperation' -TargetObject $InstanceName
+            $exception = New-Exception -Message $errorMessage -ErrorRecord $_
+
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSCD0003' -ErrorCategory 'InvalidOperation' -TargetObject $InstanceName
 
             $PSCmdlet.ThrowTerminatingError($errorRecord)
         }
@@ -197,7 +203,9 @@ function Get-SqlDscRSConfiguration
     {
         $errorMessage = $script:localizedData.Get_SqlDscRSConfiguration_ConfigurationNotFound -f $InstanceName
 
-        $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSCD0004' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
+        $exception = New-Exception -Message $errorMessage
+
+        $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSCD0004' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
 
         $PSCmdlet.ThrowTerminatingError($errorRecord)
     }

source/Public/Get-SqlDscRSExecutionLog.ps1

@@ -298,7 +298,7 @@ ORDER BY TimeStart DESC
         }
         catch
         {
-            $errorMessage = $script:localizedData.Get_SqlDscRSExecutionLog_QueryFailed -f $InstanceName, $_.Exception.Message
+            $errorMessage = $script:localizedData.Get_SqlDscRSExecutionLog_QueryFailed -f $InstanceName
 
             Write-Error -Message $errorMessage -Category 'InvalidOperation' -ErrorId 'GSRSEL0001' -TargetObject $InstanceName -Exception $_.Exception
 

source/Public/Get-SqlDscRSIPAddress.ps1

@@ -96,9 +96,11 @@ function Get-SqlDscRSIPAddress
         }
         catch
         {
-            $errorMessage = $script:localizedData.Get_SqlDscRSIPAddress_FailedToGet -f $instanceName, $_.Exception.Message
+            $errorMessage = $script:localizedData.Get_SqlDscRSIPAddress_FailedToGet -f $instanceName
 
-            $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSIP0001' -ErrorCategory 'InvalidOperation' -TargetObject $Configuration
+            $exception = New-Exception -Message $errorMessage -ErrorRecord $_
+
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSIP0001' -ErrorCategory 'InvalidOperation' -TargetObject $Configuration
 
             $PSCmdlet.ThrowTerminatingError($errorRecord)
         }

source/Public/Get-SqlDscRSLogPath.ps1

@@ -102,7 +102,9 @@ function Get-SqlDscRSLogPath
         {
             $errorMessage = $script:localizedData.Get_SqlDscRSLogPath_InstanceNotFound -f $InstanceName
 
-            $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSLP0001' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
+            $exception = New-Exception -Message $errorMessage
+
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSLP0001' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
 
             $PSCmdlet.ThrowTerminatingError($errorRecord)
         }
@@ -111,7 +113,9 @@ function Get-SqlDscRSLogPath
         {
             $errorMessage = $script:localizedData.Get_SqlDscRSLogPath_LogPathNotFound -f $InstanceName
 
-            $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSLP0002' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
+            $exception = New-Exception -Message $errorMessage
+
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSLP0002' -ErrorCategory 'ObjectNotFound' -TargetObject $InstanceName
 
             $PSCmdlet.ThrowTerminatingError($errorRecord)
         }

source/Public/Get-SqlDscRSPackage.ps1

@@ -74,14 +74,11 @@ function Get-SqlDscRSPackage
         {
             $errorMessage = $script:localizedData.Get_SqlDscRSPackage_InvalidProductName -f $versionInfo.ProductName, ($validProductNames -join "', '")
 
-            $PSCmdlet.ThrowTerminatingError(
-                [System.Management.Automation.ErrorRecord]::new(
-                    $errorMessage,
-                    'GSDRSP0002',
-                    [System.Management.Automation.ErrorCategory]::InvalidArgument,
-                    $FilePath
-                )
-            )
+            $exception = New-Exception -Message $errorMessage
+
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSDRSP0002' -ErrorCategory 'InvalidArgument' -TargetObject $FilePath
+
+            $PSCmdlet.ThrowTerminatingError($errorRecord)
         }
     }
 

source/Public/Get-SqlDscRSSslCertificate.ps1

@@ -97,9 +97,9 @@ function Get-SqlDscRSSslCertificate
         }
         catch
         {
-            $errorMessage = $script:localizedData.Get_SqlDscRSSslCertificate_FailedToGet -f $instanceName, $_.Exception.Message
+            $errorMessage = $script:localizedData.Get_SqlDscRSSslCertificate_FailedToGet -f $instanceName
 
-            $exception = New-InvalidOperationException -Message $errorMessage -ErrorRecord $_ -PassThru
+            $exception = New-Exception -Message $errorMessage -ErrorRecord $_
 
             $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSSC0001' -ErrorCategory 'InvalidOperation' -TargetObject $Configuration
 

source/Public/Get-SqlDscRSSslCertificateBinding.ps1

@@ -115,9 +115,9 @@ function Get-SqlDscRSSslCertificateBinding
         }
         catch
         {
-            $errorMessage = $script:localizedData.Get_SqlDscRSSslCertificateBinding_FailedToGet -f $instanceName, $_.Exception.Message
+            $errorMessage = $script:localizedData.Get_SqlDscRSSslCertificateBinding_FailedToGet -f $instanceName
 
-            $exception = New-InvalidOperationException -Message $errorMessage -ErrorRecord $_ -PassThru
+            $exception = New-Exception -Message $errorMessage -ErrorRecord $_
 
             $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSSCB0001' -ErrorCategory 'InvalidOperation' -TargetObject $Configuration
 

source/Public/Get-SqlDscRSUrl.ps1

@@ -75,7 +75,9 @@ function Get-SqlDscRSUrl
         {
             $errorMessage = $script:localizedData.Get_SqlDscRSUrl_VersionNotFound -f $instanceName
 
-            $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSU0001' -ErrorCategory 'InvalidOperation' -TargetObject $SetupConfiguration
+            $exception = New-Exception -Message $errorMessage
+
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSU0001' -ErrorCategory 'InvalidOperation' -TargetObject $SetupConfiguration
 
             $PSCmdlet.ThrowTerminatingError($errorRecord)
         }
@@ -98,9 +100,11 @@ function Get-SqlDscRSUrl
         }
         catch
         {
-            $errorMessage = $script:localizedData.Get_SqlDscRSUrl_FailedToGetInstance -f $instanceName, $_.Exception.Message
+            $errorMessage = $script:localizedData.Get_SqlDscRSUrl_FailedToGetInstance -f $instanceName
+
+            $exception = New-Exception -Message $errorMessage -ErrorRecord $_
 
-            $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSU0002' -ErrorCategory 'InvalidOperation' -TargetObject $SetupConfiguration
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSU0002' -ErrorCategory 'InvalidOperation' -TargetObject $SetupConfiguration
 
             $PSCmdlet.ThrowTerminatingError($errorRecord)
         }
@@ -109,7 +113,9 @@ function Get-SqlDscRSUrl
         {
             $errorMessage = $script:localizedData.Get_SqlDscRSUrl_InstanceNotFound -f $instanceName
 
-            $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSU0003' -ErrorCategory 'InvalidOperation' -TargetObject $SetupConfiguration
+            $exception = New-Exception -Message $errorMessage
+
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSU0003' -ErrorCategory 'InvalidOperation' -TargetObject $SetupConfiguration
 
             $PSCmdlet.ThrowTerminatingError($errorRecord)
         }
@@ -126,9 +132,11 @@ function Get-SqlDscRSUrl
         }
         catch
         {
-            $errorMessage = $script:localizedData.Get_SqlDscRSUrl_FailedToGetUrls -f $instanceName, $_.Exception.Message
+            $errorMessage = $script:localizedData.Get_SqlDscRSUrl_FailedToGetUrls -f $instanceName
+
+            $exception = New-Exception -Message $errorMessage -ErrorRecord $_
 
-            $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'GSRSU0004' -ErrorCategory 'InvalidOperation' -TargetObject $SetupConfiguration
+            $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'GSRSU0004' -ErrorCategory 'InvalidOperation' -TargetObject $SetupConfiguration
 
             $PSCmdlet.ThrowTerminatingError($errorRecord)
         }

source/Public/Get-SqlDscRSUrlReservation.ps1

@@ -77,7 +77,7 @@ function Get-SqlDscRSUrlReservation
         }
         catch
         {
-            $errorMessage = $script:localizedData.Get_SqlDscRSUrlReservation_FailedToGet -f $instanceName, $_.Exception.Message
+            $errorMessage = $script:localizedData.Get_SqlDscRSUrlReservation_FailedToGet -f $instanceName
 
             Write-Error -Message $errorMessage -Category 'InvalidOperation' -ErrorId 'GSRUR0001' -TargetObject $Configuration -Exception $_.Exception
 

source/Public/Initialize-SqlDscRS.ps1

@@ -119,9 +119,11 @@ function Initialize-SqlDscRS
             }
             catch
             {
-                $errorMessage = $script:localizedData.Initialize_SqlDscRS_FailedToInitialize -f $instanceName, $_.Exception.Message
+                $errorMessage = $script:localizedData.Initialize_SqlDscRS_FailedToInitialize -f $instanceName
 
-                $errorRecord = New-ErrorRecord -Exception (New-InvalidOperationException -Message $errorMessage -PassThru) -ErrorId 'ISRS0001' -ErrorCategory 'InvalidOperation' -TargetObject $Configuration
+                $exception = New-Exception -Message $errorMessage -ErrorRecord $_
+
+                $errorRecord = New-ErrorRecord -Exception $exception -ErrorId 'ISRS0001' -ErrorCategory 'InvalidOperation' -TargetObject $Configuration
 
                 $PSCmdlet.ThrowTerminatingError($errorRecord)
             }