Add version validation for IsLedger parameter (requires SQL Server 2022+)

Co-authored-by: johlju <[email protected]>

Author: Copilot

source/Public/New-SqlDscDatabase.ps1

@@ -266,6 +266,24 @@ function New-SqlDscDatabase
             }
         }
 
+        # Validate IsLedger if specified (requires SQL Server 2022+)
+        if ($PSBoundParameters.ContainsKey('IsLedger'))
+        {
+            if ($ServerObject.VersionMajor -lt 16)
+            {
+                $errorMessage = $script:localizedData.Database_IsLedgerNotSupported -f $ServerObject.InstanceName, $ServerObject.VersionMajor
+
+                $PSCmdlet.ThrowTerminatingError(
+                    [System.Management.Automation.ErrorRecord]::new(
+                        [System.InvalidOperationException]::new($errorMessage),
+                        'NSD0007', # cspell: disable-line
+                        [System.Management.Automation.ErrorCategory]::InvalidOperation,
+                        $IsLedger
+                    )
+                )
+            }
+        }
+
         # Validate source database exists when creating a snapshot
         if ($PSCmdlet.ParameterSetName -eq 'Snapshot')
         {

source/en-US/SqlServerDsc.strings.psd1

@@ -358,6 +358,7 @@ ConvertFrom-StringData @'
     Database_InvalidCompatibilityLevel = The specified compatibility level '{0}' is not a valid compatibility level for the instance '{1}'.
     Database_InvalidCollation = The specified collation '{0}' is not a valid collation for the instance '{1}'.
     Database_CatalogCollationNotSupported = The parameter CatalogCollation is not supported on SQL Server instance '{0}' with version '{1}'. This parameter requires SQL Server 2019 (version 15) or later.
+    Database_IsLedgerNotSupported = The parameter IsLedger is not supported on SQL Server instance '{0}' with version '{1}'. This parameter requires SQL Server 2022 (version 16) or later.
     Database_SnapshotSourceDatabaseNotFound = The source database '{0}' for the database snapshot does not exist on instance '{1}'.
     Database_CreatingSnapshot = Creating database snapshot '{0}' from source database '{1}'.
     Database_Create_ShouldProcessVerboseDescription = Creating the database '{0}' on the instance '{1}'.

tests/Unit/Public/New-SqlDscDatabase.Tests.ps1

@@ -104,7 +104,17 @@ Describe 'New-SqlDscDatabase' -Tag 'Public' {
         }
 
         It 'Should create a ledger database with IsLedger set to true' {
-            $result = New-SqlDscDatabase -ServerObject $mockServerObject -Name 'LedgerDatabase' -IsLedger $true -Force
+            # Create a mock server for SQL Server 2022 (version 16) which supports IsLedger
+            $mockServerObject2022 = New-Object -TypeName 'Microsoft.SqlServer.Management.Smo.Server'
+            $mockServerObject2022 | Add-Member -MemberType 'NoteProperty' -Name 'InstanceName' -Value 'TestInstance2022' -Force
+            $mockServerObject2022 | Add-Member -MemberType 'NoteProperty' -Name 'VersionMajor' -Value 16 -Force
+            $mockServerObject2022 | Add-Member -MemberType 'ScriptProperty' -Name 'Databases' -Value {
+                return @{} | Add-Member -MemberType 'ScriptMethod' -Name 'Refresh' -Value {
+                    # Mock implementation
+                } -PassThru -Force
+            } -Force
+
+            $result = New-SqlDscDatabase -ServerObject $mockServerObject2022 -Name 'LedgerDatabase' -IsLedger $true -Force
 
             $result | Should -Not -BeNullOrEmpty
             $result.Name | Should -Be 'LedgerDatabase'
@@ -160,6 +170,16 @@ Describe 'New-SqlDscDatabase' -Tag 'Public' {
             $errorRecord.CategoryInfo.Category | Should -Be 'InvalidArgument'
             $errorRecord.CategoryInfo.TargetName | Should -Be 'InvalidCollation'
         }
+
+        It 'Should throw error when IsLedger is used on SQL Server version older than 2022' {
+            $errorRecord = { New-SqlDscDatabase -ServerObject $mockServerObject -Name 'TestDB' -IsLedger $true -Force } |
+                Should -Throw -ExpectedMessage '*IsLedger is not supported*' -PassThru
+
+            $errorRecord.Exception.Message | Should -BeLike '*IsLedger is not supported*'
+            $errorRecord.FullyQualifiedErrorId | Should -Be 'NSD0007,New-SqlDscDatabase'
+            $errorRecord.CategoryInfo.Category | Should -Be 'InvalidOperation'
+            $errorRecord.CategoryInfo.TargetName | Should -Be 'True'
+        }
     }
 
     Context 'Parameter validation' {