Add WithExtendedProperties parameter to Get-SqlDscManagedComputerService function

Author: johlju

source/Public/Get-SqlDscInstalledComponent.ps1

@@ -46,7 +46,7 @@ function Get-SqlDscInstalledComponent
 
     Assert-ElevatedUser -ErrorAction 'Stop'
 
-    $serviceComponent = Get-SqlDscInstalledService -ServerName $ServerName
+    $serviceComponent = Get-SqlDscManagedComputerService -ServerName $ServerName -WithExtendedProperties
 
     $installedComponents = @()
 
@@ -57,7 +57,16 @@ function Get-SqlDscInstalledComponent
             Feature = $null
         }
 
-        switch ($currentServiceComponent.ServiceType)
+        $serviceType = if ($currentServiceComponent.ManagedServiceType)
+        {
+            $currentServiceComponent.ManagedServiceType
+        }
+        else
+        {
+            $currentServiceComponent.Type
+        }
+
+        switch ($serviceType)
         {
             # TODO: Add a Test-command for the path HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server\MSSQL16.SQL2022\ConfigurationState\SQL_FullText_Adv
             '9'

source/Public/Get-SqlDscInstalledService.ps1

@@ -19,6 +19,12 @@
     .PARAMETER ServiceType
        Specifies one or more service types to return the services for.
 
+    .PARAMETER WithExtendedProperties
+       Specifies that extended properties should be added to each returned service
+       object. This includes ManagedServiceType, ServiceExecutableVersion,
+       ServiceStartupType, and ServiceInstanceName properties. Note that retrieving
+       the executable version may take additional time.
+
     .EXAMPLE
         Get-SqlDscManagedComputer | Get-SqlDscManagedComputerService
 
@@ -45,6 +51,13 @@
 
         Returns all the managed computer service objects for instance SQL2022.
 
+    .EXAMPLE
+        Get-SqlDscManagedComputerService -WithExtendedProperties
+
+        Returns all the managed computer service objects for the current node
+        with extended properties (ManagedServiceType, ServiceExecutableVersion,
+        ServiceStartupType, and ServiceInstanceName) added to each service object.
+
     .OUTPUTS
         `[Microsoft.SqlServer.Management.Smo.Wmi.Service[]]`
 #>
@@ -71,7 +84,11 @@ function Get-SqlDscManagedComputerService
         [Parameter()]
         [ValidateSet('DatabaseEngine', 'SQLServerAgent', 'Search', 'IntegrationServices', 'AnalysisServices', 'ReportingServices', 'SQLServerBrowser', 'NotificationServices')]
         [System.String[]]
-        $ServiceType
+        $ServiceType,
+
+        [Parameter()]
+        [System.Management.Automation.SwitchParameter]
+        $WithExtendedProperties
     )
 
     begin
@@ -125,6 +142,39 @@ function Get-SqlDscManagedComputerService
                         $_.Name -match ('\${0}$' -f $InstanceName)
                     }
             }
+
+            if ($WithExtendedProperties.IsPresent)
+            {
+                foreach ($service in $serviceObject)
+                {
+                    $convertedType = $service.Type | ConvertFrom-ManagedServiceType -ErrorAction 'SilentlyContinue'
+
+                    $service | Add-Member -MemberType 'NoteProperty' -Name 'ManagedServiceType' -Value $convertedType -Force
+
+                    $fileProductVersion = $null
+
+                    $serviceExecutablePath = (($service.PathName -replace '"') -split ' -')[0]
+
+                    if ((Test-Path -Path $serviceExecutablePath))
+                    {
+                        $fileProductVersion = [System.Version] (Get-FileVersionInformation -FilePath $serviceExecutablePath).ProductVersion
+                    }
+
+                    $service | Add-Member -MemberType 'NoteProperty' -Name 'ServiceExecutableVersion' -Value $fileProductVersion -Force
+
+                    $serviceStartupType = $service.StartMode | ConvertFrom-ServiceStartMode
+
+                    $service | Add-Member -MemberType 'NoteProperty' -Name 'ServiceStartupType' -Value $serviceStartupType -Force
+
+                    # Get InstanceName from the service name if it exists.
+                    $serviceInstanceName = if ($service.Name -match '\$(.*)$')
+                    {
+                        $Matches[1]
+                    }
+
+                    $service | Add-Member -MemberType 'NoteProperty' -Name 'ServiceInstanceName' -Value $serviceInstanceName -Force
+                }
+            }
         }
 
         return $serviceObject

source/Public/Get-SqlDscManagedComputerService.ps1

@@ -191,4 +191,132 @@ Describe 'Get-SqlDscManagedComputerService' -Tag @('Integration_SQL2017', 'Integ
             $firstService.Parent.Name | Should -Be $script:mockServerName
         }
     }
+
+    Context 'When validating extended properties with WithExtendedProperties parameter' {
+        It 'Should return services with all extended properties added' {
+            $result = Get-SqlDscManagedComputerService -ServerName $script:mockServerName -WithExtendedProperties -ErrorAction 'Stop'
+
+            $result | Should -Not -BeNullOrEmpty
+            $result | Should -BeOfType ([Microsoft.SqlServer.Management.Smo.Wmi.Service])
+
+            # Verify each service has all extended properties
+            foreach ($service in $result)
+            {
+                $service.PSObject.Properties.Name | Should -Contain 'ManagedServiceType'
+                $service.PSObject.Properties.Name | Should -Contain 'ServiceExecutableVersion'
+                $service.PSObject.Properties.Name | Should -Contain 'ServiceStartupType'
+                $service.PSObject.Properties.Name | Should -Contain 'ServiceInstanceName'
+
+                # If the service is a SQL Server service, verify it has a converted type
+                if ($service.Type -eq 'SqlServer')
+                {
+                    $service.ManagedServiceType | Should -Be 'DatabaseEngine'
+                }
+                elseif ($service.Type -eq 'SqlBrowser')
+                {
+                    $service.ManagedServiceType | Should -Be 'SQLServerBrowser'
+                }
+                elseif ($service.Type -eq 'SqlAgent')
+                {
+                    $service.ManagedServiceType | Should -Be 'SqlServerAgent'
+                }
+
+                # Verify ServiceStartupType is normalized
+                if ($service.StartMode -eq 'Auto')
+                {
+                    $service.ServiceStartupType | Should -Be 'Automatic'
+                }
+            }
+        }
+
+        It 'Should have ServiceInstanceName for named instances' {
+            $result = Get-SqlDscManagedComputerService -ServerName $script:mockServerName -InstanceName $script:mockInstanceName -WithExtendedProperties -ErrorAction 'Stop'
+
+            if ($result)
+            {
+                $result | Should -BeOfType ([Microsoft.SqlServer.Management.Smo.Wmi.Service])
+
+                # All returned services should have ServiceInstanceName property
+                foreach ($service in $result)
+                {
+                    $service.PSObject.Properties.Name | Should -Contain 'ServiceInstanceName'
+                    $service.ServiceInstanceName | Should -Be $script:mockInstanceName
+                }
+            }
+        }
+
+        It 'Should have ServiceExecutableVersion populated when executable exists' {
+            $result = Get-SqlDscManagedComputerService -ServerName $script:mockServerName -ServiceType 'DatabaseEngine' -WithExtendedProperties -ErrorAction 'Stop'
+
+            $result | Should -Not -BeNullOrEmpty
+
+            # At least one service should have a version
+            $servicesWithVersion = $result | Where-Object -FilterScript { $null -ne $_.ServiceExecutableVersion }
+            $servicesWithVersion | Should -Not -BeNullOrEmpty
+
+            # Verify version is of correct type
+            foreach ($service in $servicesWithVersion)
+            {
+                $service.ServiceExecutableVersion | Should -BeOfType ([System.Version])
+            }
+        }
+
+        Context 'When filtering by ServiceType with WithExtendedProperties' {
+            It 'Should return only Database Engine services with all extended properties' {
+                $result = Get-SqlDscManagedComputerService -ServerName $script:mockServerName -ServiceType 'DatabaseEngine' -WithExtendedProperties -ErrorAction 'Stop'
+
+                $result | Should -Not -BeNullOrEmpty
+                $result | Should -BeOfType ([Microsoft.SqlServer.Management.Smo.Wmi.Service])
+
+                # All returned services should be of type SqlServer and have all extended properties
+                foreach ($service in $result)
+                {
+                    $service.Type | Should -Be 'SqlServer'
+                    $service.PSObject.Properties.Name | Should -Contain 'ManagedServiceType'
+                    $service.ManagedServiceType | Should -Be 'DatabaseEngine'
+                    $service.PSObject.Properties.Name | Should -Contain 'ServiceExecutableVersion'
+                    $service.PSObject.Properties.Name | Should -Contain 'ServiceStartupType'
+                    $service.PSObject.Properties.Name | Should -Contain 'ServiceInstanceName'
+                }
+            }
+        }
+
+        Context 'When using managed computer object with WithExtendedProperties' {
+            BeforeAll {
+                $script:managedComputerObjectForExtended = Get-SqlDscManagedComputer -ServerName $script:mockServerName -ErrorAction 'Stop'
+            }
+
+            It 'Should return services with all extended properties from pipeline' {
+                $result = $script:managedComputerObjectForExtended | Get-SqlDscManagedComputerService -WithExtendedProperties -ErrorAction 'Stop'
+
+                $result | Should -Not -BeNullOrEmpty
+                $result | Should -BeOfType ([Microsoft.SqlServer.Management.Smo.Wmi.Service])
+
+                # Verify each service has all extended properties
+                foreach ($service in $result)
+                {
+                    $service.PSObject.Properties.Name | Should -Contain 'ManagedServiceType'
+                    $service.PSObject.Properties.Name | Should -Contain 'ServiceExecutableVersion'
+                    $service.PSObject.Properties.Name | Should -Contain 'ServiceStartupType'
+                    $service.PSObject.Properties.Name | Should -Contain 'ServiceInstanceName'
+                }
+            }
+        }
+    }
+
+    Context 'When not using WithExtendedProperties parameter' {
+        It 'Should not add extended properties to service objects' {
+            $result = Get-SqlDscManagedComputerService -ServerName $script:mockServerName -ErrorAction 'Stop'
+
+            $result | Should -Not -BeNullOrEmpty
+            $result | Should -BeOfType ([Microsoft.SqlServer.Management.Smo.Wmi.Service])
+
+            # Verify extended properties are NOT added
+            $firstService = $result | Select-Object -First 1
+            $firstService.PSObject.Properties.Name | Should -Not -Contain 'ManagedServiceType'
+            $firstService.PSObject.Properties.Name | Should -Not -Contain 'ServiceExecutableVersion'
+            $firstService.PSObject.Properties.Name | Should -Not -Contain 'ServiceStartupType'
+            $firstService.PSObject.Properties.Name | Should -Not -Contain 'ServiceInstanceName'
+        }
+    }
 }