Get-SqlDscPreferredModuleName: New command proposal

[johlju]

Command proposal

Suggest adding a new command Get-SqlDscPreferredModuleName that will return the name (or path) of the best available module name to import.

Proposed parameters

Parameter	Mandatory	Data type	Description	Default value	Allowed values
PreferredModule	No	String[]	Specifies the name of one or more preferred modules. The ordered specified will be the order they will be evaluated, Defaults to 'SqlServer'.	@('SqlServer')	Any string

Special considerations or limitations

The following code should be moved, and instead replaced with this new command:

SqlServerDsc/source/Public/Import-SqlDscPreferredModule.ps1

Lines 77 to 123 in 5efa82d

	$availableModuleName = $null
	# Get the newest SqlServer module if more than one exist
	$availableModule = Get-Module -FullyQualifiedName $PreferredModule -ListAvailable |
	Sort-Object -Property 'Version' -Descending |
	Select-Object -First 1 -Property 'Name', 'Path', 'Version'
	if ($availableModule)
	{
	$availableModuleName = $availableModule.Name
	Write-Verbose -Message ($script:localizedData.PreferredModule_ModuleFound -f $availableModuleName)
	}
	else
	{
	Write-Verbose -Message ($script:localizedData.PreferredModule_ModuleNotFound)
	# Only run on Windows that has Machine state.
	if (-not ($IsLinux -or $IsMacOS))
	{
	<#
	After installing SQL Server the current PowerShell session doesn't know
	about the new path that was added for the SQLPS module. This reloads
	PowerShell session environment variable PSModulePath to make sure it
	contains all paths.
	#>
	Set-PSModulePath -Path ([System.Environment]::GetEnvironmentVariable('PSModulePath', 'Machine'))
	}
	# Get the newest SQLPS module if more than one exist.
	$availableModule = Get-Module -FullyQualifiedName 'SQLPS' -ListAvailable |
	Select-Object -Property Name, Path, @{
	Name = 'Version'
	Expression = {
	# Parse the build version number '120', '130' from the Path.
	(Select-String -InputObject $_.Path -Pattern '\\([0-9]{3})\\' -List).Matches.Groups[1].Value
	}
	} |
	Sort-Object -Property 'Version' -Descending |
	Select-Object -First 1
	if ($availableModule)
	{
	# This sets $availableModuleName to the Path of the module to be loaded.
	$availableModuleName = Split-Path -Path $availableModule.Path -Parent
	}
	}