SqlServerDsc

16.5.0

Module with DSC resources for deployment and configuration of Microsoft SQL Server.

Minimum PowerShell version

5.0

There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name SqlServerDsc -RequiredVersion 16.5.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name SqlServerDsc -Version 16.5.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Author(s)

DSC Community

Copyright

Copyright the DSC Community contributors. All rights reserved.

Package Details

Owners

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

Functions

Add-SqlDscNode Add-SqlDscTraceFlag Complete-SqlDscFailoverCluster Complete-SqlDscImage Connect-SqlDscDatabaseEngine ConvertFrom-SqlDscDatabasePermission ConvertFrom-SqlDscServerPermission ConvertTo-SqlDscDatabasePermission ConvertTo-SqlDscServerPermission Disable-SqlDscAudit Disconnect-SqlDscDatabaseEngine Enable-SqlDscAudit Get-SqlDscAudit Get-SqlDscConfigurationOption Get-SqlDscDatabasePermission Get-SqlDscManagedComputer Get-SqlDscManagedComputerService Get-SqlDscPreferredModule Get-SqlDscServerPermission Get-SqlDscStartupParameter Get-SqlDscTraceFlag Import-SqlDscPreferredModule Initialize-SqlDscRebuildDatabase Install-SqlDscServer Invoke-SqlDscQuery New-SqlDscAudit Remove-SqlDscAudit Remove-SqlDscNode Remove-SqlDscTraceFlag Repair-SqlDscServer Set-SqlDscAudit Set-SqlDscDatabasePermission Set-SqlDscServerPermission Set-SqlDscStartupParameter Set-SqlDscTraceFlag Test-SqlDscIsDatabasePrincipal Test-SqlDscIsLogin Test-SqlDscIsSupportedFeature Uninstall-SqlDscServer

DSCResources

SqlAudit SqlDatabasePermission SqlPermission SqlAG SqlAGDatabase SqlAgentAlert SqlAgentFailsafe SqlAgentOperator SqlAGListener SqlAGReplica SqlAlias SqlAlwaysOnService SqlConfiguration SqlDatabase SqlDatabaseDefaultLocation SqlDatabaseMail SqlDatabaseObjectPermission SqlDatabaseRole SqlDatabaseUser SqlEndpoint SqlEndpointPermission SqlLogin SqlMaxDop SqlMemory SqlProtocol SqlProtocolTcpIp SqlReplication SqlRole SqlRS SqlRSSetup SqlScript SqlScriptQuery SqlSecureConnection SqlServiceAccount SqlSetup SqlTraceFlag SqlWaitForAG SqlWindowsFirewall

Dependencies

This module has no dependencies.

Release Notes

## [16.5.0] - 2023-10-03

### Fixed

- SqlDatabase
 - Add Version160 to CompatibilityLevel ValidateSet

### Added

- SqlServerDsc
 - Updated pipeline files to support ModuleFast and PSResourceGet.
 - `Get-SqlDscPreferredModule`
   - Optionally specify what version of the the SQL preferred module to
     be imported using the SMODefaultModuleVersion environment variable
     ([issue #1965](https://github.com/dsccommunity/SqlServerDsc/issues/1965)).
 - Now package the Wiki content and adds it as a GitHub Release asset so it
   is simpler to get the documentation for a specific version.
 - CODEOWNERS file was added to support automatically set reviewer.
- New private command:
 - Get-SMOModuleCalculatedVersion - Returns the version of the SMO module
   as a string. SQLPS version 120 and 130 do not have the correct version set,
   so the file path is used to calculate the version.
- SqlSetup
 - Added the parameter `SqlVersion` that can be used to set the SQL Server
   version to be installed instead of it looking for version in the setup
   executable of the SQL Server media. This parameter is not allowed for
   the setup action `Upgrade`, if specified it will throw an exception
   ([issue #1946](https://github.com/dsccommunity/SqlServerDsc/issues/1946)).

### Changed

- SqlRs
 - Updated examples to use xPSDesiredStateConfiguration instead of PSDScResources.
 - Updated integration tests to use xPSDesiredStateConfiguration instead of PSDScResources.
- SqlScript
 - Updated examples to use xPSDesiredStateConfiguration instead of PSDScResources.
 - Updated integration tests to use xPSDesiredStateConfiguration instead of PSDScResources.
- SqlScriptQuery
 - Updated examples to use xPSDesiredStateConfiguration instead of PSDScResources.
- SqlSetup
 - Updated examples to use xPSDesiredStateConfiguration instead of PSDScResources.
 - Updated integration tests to use xPSDesiredStateConfiguration instead of PSDScResources.
- SqlAlwaysOnService
 - Updated integration tests to use xPSDesiredStateConfiguration instead of PSDScResources.
- SqlLogin
 - Updated integration tests to use xPSDesiredStateConfiguration instead of PSDScResources.
- SqlReplication
 - Updated integration tests to use xPSDesiredStateConfiguration instead of PSDScResources.
- SqlRSSetup
 - Updated integration tests to use xPSDesiredStateConfiguration instead of PSDScResources.
- SqlServiceAccount
 - Updated integration tests to use xPSDesiredStateConfiguration instead of PSDScResources.
- SqlWindowsFirewall
 - Updated integration tests to use xPSDesiredStateConfiguration instead of PSDScResources.
- SqlServerDsc
 - `Get-SqlDscPreferredModule`
   - Now returns a PSModuleInfo object instead of just the module name.
 - `Import-SqlDscPreferredModule`
   - Handles PSModuleInfo objects from `Get-SqlDscPreferredModule` instead of strings.
   - Sets -ErrorAction 'Stop' on Get-SqlDscPreferredModule to throw an error if
     no SQL module is found. The script-terminating error is caught and made into
     a statement-terminating error.
 - Bump GitHub Action Checkout to v4.
- SqlAGListener
 - Made the resource cluster aware. When ProcessOnlyOnActiveNode is specified,
   the resource will only determine if a change is needed if the target node
   is the active host of the SQL Server instance ([issue #871](https://github.com/dsccommunity/SqlServerDsc/issues/871)).

### Remove

- SqlServerDsc
 - Removed PreferredModule_ModuleFound string in favor for more verbose PreferredModule_ModuleVersionFound.

FileList

Version History

Version Downloads Last updated
16.6.0-previ... 42 1/20/2024
16.6.0-previ... 3 1/19/2024
16.5.1-previ... 65 12/15/2023
16.5.1-previ... 88 11/19/2023
16.5.1-previ... 44 11/2/2023
16.5.0 (current version) 115,096 10/5/2023
16.5.0-previ... 9 10/1/2023
16.5.0-previ... 4 9/29/2023
16.5.0-previ... 44 9/1/2023
16.5.0-previ... 4 8/26/2023
16.4.1-previ... 3 8/25/2023
16.4.0 111,109 8/22/2023
16.4.0-previ... 2 8/20/2023
16.4.0-previ... 2 8/20/2023
16.4.0-previ... 3 8/19/2023
16.4.0-previ... 73 5/18/2023
16.4.0-previ... 17 5/10/2023
16.4.0-previ... 3 5/9/2023
16.4.0-previ... 4 5/8/2023
16.3.1 458,767 5/6/2023
16.3.1-previ... 2 5/6/2023
16.3.1-previ... 6 5/4/2023
16.3.0 42,055 4/26/2023
16.3.0-previ... 4 4/26/2023
16.3.0-previ... 3 4/25/2023
16.3.0-previ... 3 4/24/2023
16.3.0-previ... 3 4/23/2023
16.3.0-previ... 18 4/18/2023
16.3.0-previ... 2 4/16/2023
16.2.1-previ... 4 4/12/2023
16.2.0 74,939 4/10/2023
16.2.0-previ... 2 4/10/2023
16.2.0-previ... 2 4/8/2023
16.2.0-previ... 2 4/8/2023
16.2.0-previ... 7 4/6/2023
16.2.0-previ... 7 4/1/2023
16.2.0-previ... 8 3/28/2023
16.2.0-previ... 7 3/26/2023
16.2.0-previ... 2 3/25/2023
16.2.0-previ... 165 3/19/2023
16.2.0-previ... 24 3/7/2023
16.2.0-previ... 7 3/4/2023
16.1.0 175,363 2/28/2023
16.1.0-previ... 3 2/28/2023
16.1.0-previ... 6 2/25/2023
16.1.0-previ... 3 2/24/2023
16.1.0-previ... 45 2/13/2023
16.1.0-previ... 25 2/12/2023
16.1.0-previ... 22 2/5/2023
16.1.0-previ... 8 2/1/2023
16.1.0-previ... 26 1/25/2023
16.1.0-previ... 5 1/24/2023
16.1.0-previ... 2 1/24/2023
16.1.0-previ... 9 1/22/2023
16.1.0-previ... 343 1/4/2023
16.1.0-previ... 3 1/3/2023
16.1.0-previ... 12 12/26/2022
16.1.0-previ... 47 12/19/2022
16.1.0-previ... 10 12/17/2022
16.1.0-previ... 111 12/11/2022
16.1.0-previ... 10 12/4/2022
16.1.0-previ... 33 11/26/2022
16.1.0-previ... 8 11/24/2022
16.0.1-previ... 28 11/11/2022
16.0.0 826,179 9/9/2022
16.0.0-previ... 27 8/21/2022
16.0.0-previ... 21 8/13/2022
16.0.0-previ... 12 8/13/2022
16.0.0-previ... 23 8/1/2022
16.0.0-previ... 78 6/14/2022
16.0.0-previ... 22 6/8/2022
16.0.0-previ... 15 6/6/2022
16.0.0-previ... 12 6/6/2022
16.0.0-previ... 86 4/26/2022
16.0.0-previ... 42 3/28/2022
16.0.0-previ... 63 2/12/2022
15.2.0 2,682,739 9/1/2021
15.2.0-previ... 13 9/1/2021
15.2.0-previ... 42 7/23/2021
15.2.0-previ... 73 6/6/2021
15.2.0-previ... 63 4/18/2021
15.2.0-previ... 83 3/12/2021
15.1.1 1,377,035 2/12/2021
15.1.1-previ... 15 2/12/2021
15.1.0 62,157 2/2/2021
15.1.0-previ... 22 2/1/2021
15.1.0-previ... 17 1/31/2021
15.0.2-previ... 16 1/30/2021
15.0.2-previ... 22 1/24/2021
15.0.2-previ... 60 1/21/2021
15.0.2-previ... 59 1/12/2021
15.0.1 143,007 1/9/2021
15.0.1-previ... 56 1/9/2021
15.0.1-previ... 61 1/6/2021
15.0.1-previ... 57 1/6/2021
15.0.1-previ... 66 12/27/2020
15.0.1-previ... 57 12/26/2020
15.0.1-previ... 60 12/23/2020
15.0.1-previ... 68 12/14/2020
15.0.1-previ... 59 12/13/2020
15.0.1-previ... 57 12/12/2020
15.0.1-previ... 58 12/10/2020
15.0.0 213,865 12/6/2020
15.0.0-previ... 58 12/6/2020
15.0.0-previ... 63 11/25/2020
15.0.0-previ... 55 11/22/2020
15.0.0-previ... 59 11/21/2020
14.3.0-previ... 96 10/5/2020
14.3.0-previ... 52 10/3/2020
14.3.0-previ... 58 10/2/2020
14.2.2-previ... 102 8/19/2020
14.2.2-previ... 58 8/16/2020
14.2.1 639,165 8/14/2020
14.2.1-previ... 57 8/13/2020
14.2.1-previ... 58 8/11/2020
14.2.1-previ... 54 8/11/2020
14.2.1-previ... 69 7/31/2020
14.2.1-previ... 57 7/28/2020
14.2.0 72,544 7/23/2020
14.2.0-previ... 60 7/23/2020
14.2.0-previ... 62 7/19/2020
14.2.0-previ... 71 7/13/2020
14.2.0-previ... 62 7/10/2020
14.2.0-previ... 59 7/9/2020
14.1.1-previ... 61 7/9/2020
14.1.0 203,974 7/6/2020
14.1.0-previ... 353 7/5/2020
14.1.0-previ... 58 7/4/2020
14.1.0-previ... 59 7/4/2020
14.1.0-previ... 61 7/3/2020
14.1.0-previ... 63 7/1/2020
14.0.1-previ... 69 6/28/2020
14.0.1-previ... 58 6/26/2020
14.0.0 10,829 6/12/2020
14.0.0-previ... 59 6/12/2020
14.0.0-previ... 65 6/11/2020
14.0.0-previ... 67 6/10/2020
14.0.0-previ... 66 6/10/2020
14.0.0-previ... 100 5/28/2020
14.0.0-previ... 75 5/25/2020
14.0.0-previ... 65 5/25/2020
14.0.0-previ... 77 5/19/2020
14.0.0-previ... 73 5/19/2020
14.0.0-previ... 79 5/17/2020
14.0.0-previ... 68 5/17/2020
14.0.0-previ... 66 5/16/2020
14.0.0-previ... 67 5/14/2020
14.0.0-previ... 69 5/13/2020
14.0.0-previ... 77 5/12/2020
14.0.0-previ... 67 5/12/2020
14.0.0-previ... 67 5/12/2020
14.0.0-previ... 80 5/8/2020
14.0.0-previ... 66 5/6/2020
14.0.0-previ... 70 5/5/2020
14.0.0-previ... 68 5/4/2020
14.0.0-previ... 67 5/3/2020
14.0.0-previ... 66 5/3/2020
14.0.0-previ... 81 4/27/2020
14.0.0-previ... 76 4/26/2020
13.5.0 28,227 4/12/2020
13.5.0-previ... 73 4/11/2020
13.5.0-previ... 75 4/11/2020
13.4.1-previ... 102 3/31/2020
13.4.0 122,336 3/18/2020
13.4.0-previ... 68 3/18/2020
13.3.1-previ... 114 1/18/2020
13.3.0 480,135 1/17/2020
13.3.0-previ... 71 1/17/2020
13.3.0-previ... 76 1/12/2020
13.3.0-previ... 70 1/8/2020
13.3.0-previ... 73 1/7/2020
13.3.0-previ... 70 1/3/2020
13.3.0-previ... 71 1/2/2020
13.3.0-previ... 72 1/2/2020
13.2.0.0 859,606 9/19/2019
13.1.0.0 34,980 8/8/2019
13.0.0.0 26,014 6/26/2019
12.5.0.0 17,272 5/15/2019
12.4.0.0 21,689 4/3/2019
12.3.0.0 40,216 2/20/2019
12.2.0.0 8,917 1/10/2019
12.1.0.0 23,189 10/25/2018
12.0.0.0 21,417 9/5/2018
11.4.0.0 16,146 7/25/2018
11.3.0.0 7,370 6/13/2018
11.2.0.0 4,907 5/2/2018
11.1.0.0 6,193 3/22/2018
11.0.0.0 12,676 2/8/2018
10.0.0.0 3,643 12/14/2017
Show less