SqlServerDsc

14.0.0-preview0013

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

Minimum PowerShell version

5.0

This is a prerelease version of SqlServerDsc.
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 14.0.0-preview0013 -AllowPrerelease

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

Install-PSResource -Name SqlServerDsc -Version 14.0.0-preview0013 -Prerelease

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

Owners

Copyright

Copyright the DSC Community contributors. All rights reserved.

Package Details

Author(s)

  • DSC Community

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

DSCResources

SqlAG SqlAGDatabase SqlAgentAlert SqlAgentFailsafe SqlAgentOperator SqlAGListener SqlAGReplica SqlAlias SqlAlwaysOnService SqlDatabase SqlDatabaseDefaultLocation SqlDatabaseOwner SqlDatabasePermission SqlDatabaseRecoveryModel SqlDatabaseRole SqlDatabaseUser SqlRS SqlRSSetup SqlScript SqlScriptQuery SqlServerConfiguration SqlServerDatabaseMail SqlServerEndpoint SqlServerEndpointPermission SqlServerEndpointState SqlServerLogin SqlServerMaxDop SqlServerMemory SqlServerNetwork SqlServerPermission SqlServerProtocol SqlServerProtocolTcpIp SqlServerReplication SqlServerRole SqlServerSecureConnection SqlServiceAccount SqlSetup SqlWaitForAG SqlWindowsFirewall

Dependencies

This module has no dependencies.

Release Notes

## [14.0.0-preview0013] - 2020-05-14

### Remove

- SqlServerDsc
 - BREAKING CHANGE: Since the operating system Windows Server 2008 R2 and
   the product SQL Server 2008 R2 has gone end-of-life the DSC resources
   will no longer try to maintain compatibility with them. Moving forward,
   and including this release, there may be code changes that will break
   the resource on Windows Server 2008 R2 or with SQL Server 2008 R2
   ([issue #1514](https://github.com/dsccommunity/SqlServerDsc/issues/1514)).

### Deprecated

The documentation, examples, unit test, and integration tests have been
removed for these deprecated resources. These resources will be removed
in a future release.

- SqlDatabaseOwner
 - This resource is now deprecated. The functionality is now covered by
   a property in the resource _SqlDatabase_ ([issue #966](https://github.com/dsccommunity/SqlServerDsc/issues/966)).
- SqlDatabaseRecoveryModel
 - This resource is now deprecated. The functionality is now covered by
   a property in the resource _SqlDatabase_ ([issue #967](https://github.com/dsccommunity/SqlServerDsc/issues/967)).
- SqlServerEndpointState
 - This resource is now deprecated. The functionality is covered by a
   property in the resource _SqlServerEndpoint_ ([issue #968](https://github.com/dsccommunity/SqlServerDsc/issues/968)).
- SqlServerNetwork
 - This resource is now deprecated. The functionality is now covered by
   the resources _SqlServerProtocol_ and _SqlServerProtocolTcpIp_.

### Added

- SqlServerDsc
 - Added new resource SqlServerProtocol ([issue #1377](https://github.com/dsccommunity/SqlServerDsc/issues/1377)).
 - Added new resource SqlServerProtocolTcpIp ([issue #1378](https://github.com/dsccommunity/SqlServerDsc/issues/1378)).
 - Fixing a problem with the latest ModuleBuild 1.7.0 that breaks the CI
   pipeline.
- SqlServerEndpoint
 - BREAKING CHANGE: A new required property `EndpointType` was added to
   support different types of endpoints in the future. For now the only
   endpoint type that is supported is the database mirror endpoint type
   (`DatabaseMirroring`).
 - Added the property `State` to be able to specify if the endpoint should
   be running, stopped, or disabled. _This property was moved from the now_
   _deprecated DSC resource `SqlServerEndpointState`_.
- SqlSetup
 - A read only property `IsClustered` was added that can be used to determine
   if the instance is clustered.
 - Added the properties `NpEnabled` and `TcpEnabled` ([issue #1161](https://github.com/dsccommunity/SqlServerDsc/issues/1161)).
- SqlServerReplication
 - Add integration tests ([issue #755](https://github.com/dsccommunity/SqlServerDsc/issues/755)
- SqlDatabase
 - The property `OwnerName` was added.
- SqlServerDsc.Common
 - The helper function `Restart-SqlService` was improved to handle Failover
   Clusters better. Now the SQL Server service will only be taken offline
   and back online again if the service is online to begin with.
 - The helper function `Restart-SqlServer` learned the new parameter
   `OwnerNode`. The parameter `OwnerNode` takes an array of Cluster node
   names. Using this parameter the cluster group will only be taken
   offline and back online if the cluster group owner is one specified
   in this parameter.

### Changed

- SqlServerDsc
 - Changed all resource prefixes from `MSFT_` to `DSC_` ([issue #1496](https://github.com/dsccommunity/SqlServerDsc/issues/1496)).
   _Deprecated resource has not changed prefix._
 - All resources are now using the common module DscResource.Common.
 - When a PR is labelled with 'ready for merge' it is no longer being
   marked as stale if the PR is not merged for 30 days (for example it is
   dependent on something else) ([issue #1504](https://github.com/dsccommunity/SqlServerDsc/issues/1504)).
 - Updated the CI pipeline to use latest version of the module ModuleBuilder.
 - Changed to use the property `NuGetVersionV2` from GitVersion in the
   CI pipeline.
 - The unit tests now run on PowerShell 7 to optimize the total run time.
- SqlServerDsc.Common
 - The helper function `Invoke-InstallationMediaCopy` was changed to
   handle a breaking change in PowerShell 7 ([issue #1530](https://github.com/dsccommunity/SqlServerDsc/issues/1530)).
- CommonTestHelper
 - The test helper function `New-SQLSelfSignedCertificate` was changed
   to install the dependent module `PSPKI` through `RequiredModules.psd1`.
- SqlAlwaysOnService
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - Normalize parameter descriptive text for default values.
- SqlDatabase
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - BREAKING CHANGE: The non-mandatory parameters was removed from the
   function `Get-TargetResource` since they were not needed.
 - BREAKING CHANGE: The properties `CompatibilityLevel` and `Collation`
   are now only enforced if the are specified in the configuration.
 - Normalize parameter descriptive text for default values.
- SqlDatabaseDefaultLocation
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - Normalize parameter descriptive text for default values.
- SqlDatabaseOwner
 - BREAKING CHANGE: Database changed to DatabaseName for consistency with
   other modules ([issue #1484](https://github.com/dsccommunity/SqlServerDsc/issues/1484)).
- SqlDatabasePermission
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - Normalize parameter descriptive text for default values.
 - BREAKING CHANGE: Database changed to DatabaseName for consistency with
   other modules ([issue #1484](https://github.com/dsccommunity/SqlServerDsc/issues/1484)).
- SqlDatabaseRecoveryModel
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - Normalize parameter descriptive text for default values.
- SqlDatabaseRole
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - Normalize parameter descriptive text for default values.
 - BREAKING CHANGE: Database changed to DatabaseName for consistency with
   other modules ([issue #1484](https://github.com/dsccommunity/SqlServerDsc/issues/1484)).
- SqlDatabaseUser
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - Normalize parameter descriptive text for default values.
- SqlServerConfiguration
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - Normalize parameter descriptive text for default values.
- SqlServerDatabaseMail
 - Normalize parameter descriptive text for default values.
- SqlServerEndpoint
 - BREAKING CHANGE: Now the properties are only enforced if they are
   specified in the configuration.
 - Normalize parameter descriptive text for default values.
- SqlServerEndpointPermission
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - Normalize parameter descriptive text for default values.
- SqlServerLogin
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - Normalize parameter descriptive text for default values.
- SqlServerRole
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - Normalize parameter descriptive text for default values.
- SqlServiceAccount
 - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
   defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
 - Normalize parameter descriptive text for default values.
- SqlSetup
 - BREAKING CHANGE: Now if the parameter `AgtSvcStartupType` is not specified
   in the configuration the resource will no longer by default add an
   argument to `setup.exe` with a value of `Automatic` for the argument
   `AGTSVCSTARTUPTYPE`. If the parameter `AgtSvcStartupType` is not specified
   in the configuration there will be no setup argument added at all
   ([issue #464](https://github.com/dsccommunity/SqlServerDsc/issues/464)).
 - BREAKING CHANGE: Now, unless the parameter `SuppressReboot` is set to
   `$true`, the node will be restarted if the setup ends with the
   [error code 3010](https://docs.microsoft.com/en-us/previous-versions/tn-archive/bb418811(v=technet.10)#server-setup-fails-with-code-3010).
   Previously just a warning message was written ([issue #565](https://github.com/dsccommunity/SqlServerDsc/issues/565)).

### Fixed

- SqlServerDsc
 - The regular expression for `minor-version-bump-message` in the file
   `GitVersion.yml` was changed to only raise minor version when the
   commit message contain the word `add`, `adds`, `minor`, `feature`,
   or `features`.
 

FileList

Version History

Version Downloads Last updated
17.3.0-previ... 8 10/26/2025
17.3.0-previ... 4 10/24/2025
17.3.0-previ... 8 10/22/2025
17.3.0-previ... 4 10/21/2025
17.3.0-previ... 9 10/15/2025
17.3.0-previ... 12 10/12/2025
17.3.0-previ... 3 10/11/2025
17.3.0-previ... 5 10/10/2025
17.3.0-previ... 6 10/7/2025
17.3.0-previ... 11 9/28/2025
17.3.0-previ... 4 9/26/2025
17.3.0-previ... 4 9/24/2025
17.3.0-previ... 5 9/21/2025
17.2.0 173,663 9/16/2025
17.2.0-previ... 3 9/15/2025
17.2.0-previ... 6 9/13/2025
17.2.0-previ... 5 9/12/2025
17.2.0-previ... 13 9/7/2025
17.2.0-previ... 5 9/6/2025
17.2.0-previ... 5 9/6/2025
17.2.0-previ... 10 9/1/2025
17.2.0-previ... 4 8/31/2025
17.2.0-previ... 4 8/31/2025
17.2.0-previ... 5 8/30/2025
17.2.0-previ... 5 8/30/2025
17.2.0-previ... 4 8/29/2025
17.2.0-previ... 15 8/25/2025
17.2.0-previ... 11 8/22/2025
17.2.0-previ... 5 8/19/2025
17.2.0-previ... 16 8/9/2025
17.2.0-previ... 15 8/3/2025
17.1.0 519,742 5/22/2025
17.1.0-previ... 27 5/2/2025
17.1.0-previ... 6 5/1/2025
17.1.0-previ... 37 4/7/2025
17.1.0-previ... 7 4/6/2025
17.1.0-previ... 7 4/4/2025
17.1.0-previ... 44 3/24/2025
17.1.0-previ... 14 3/19/2025
17.1.0-previ... 12 3/13/2025
17.1.0-previ... 8 3/12/2025
17.1.0-previ... 5 3/11/2025
17.1.0-previ... 30 3/4/2025
17.1.0-previ... 9 3/2/2025
17.0.1-previ... 106 10/29/2024
17.0.1-previ... 8 10/26/2024
17.0.1-previ... 17 10/7/2024
17.0.0 2,433,419 9/30/2024
17.0.0-previ... 9 9/29/2024
17.0.0-previ... 52 8/13/2024
16.6.1-previ... 120 5/23/2024
16.6.1-previ... 7 5/22/2024
16.6.0 93,238 5/17/2024
16.6.0-previ... 12 5/12/2024
16.6.0-previ... 6 5/11/2024
16.6.0-previ... 117 3/3/2024
16.6.0-previ... 48 1/20/2024
16.6.0-previ... 8 1/19/2024
16.5.1-previ... 70 12/15/2023
16.5.1-previ... 93 11/19/2023
16.5.1-previ... 49 11/2/2023
16.5.0 145,953 10/5/2023
16.5.0-previ... 15 10/1/2023
16.5.0-previ... 10 9/29/2023
16.5.0-previ... 51 9/1/2023
16.5.0-previ... 9 8/26/2023
16.4.1-previ... 8 8/25/2023
16.4.0 111,836 8/22/2023
16.4.0-previ... 7 8/20/2023
16.4.0-previ... 7 8/20/2023
16.4.0-previ... 7 8/19/2023
16.4.0-previ... 78 5/18/2023
16.4.0-previ... 22 5/10/2023
16.4.0-previ... 8 5/9/2023
16.4.0-previ... 10 5/8/2023
16.3.1 460,811 5/6/2023
16.3.1-previ... 7 5/6/2023
16.3.1-previ... 11 5/4/2023
16.3.0 42,412 4/26/2023
16.3.0-previ... 10 4/26/2023
16.3.0-previ... 9 4/25/2023
16.3.0-previ... 8 4/24/2023
16.3.0-previ... 7 4/23/2023
16.3.0-previ... 30 4/18/2023
16.3.0-previ... 9 4/16/2023
16.2.1-previ... 10 4/12/2023
16.2.0 75,351 4/10/2023
16.2.0-previ... 8 4/10/2023
16.2.0-previ... 7 4/8/2023
16.2.0-previ... 7 4/8/2023
16.2.0-previ... 12 4/6/2023
16.2.0-previ... 13 4/1/2023
16.2.0-previ... 14 3/28/2023
16.2.0-previ... 12 3/26/2023
16.2.0-previ... 7 3/25/2023
16.2.0-previ... 173 3/19/2023
16.2.0-previ... 29 3/7/2023
16.2.0-previ... 11 3/4/2023
16.1.0 175,791 2/28/2023
16.1.0-previ... 7 2/28/2023
16.1.0-previ... 10 2/25/2023
16.1.0-previ... 10 2/24/2023
16.1.0-previ... 50 2/13/2023
16.1.0-previ... 30 2/12/2023
16.1.0-previ... 27 2/5/2023
16.1.0-previ... 14 2/1/2023
16.1.0-previ... 31 1/25/2023
16.1.0-previ... 10 1/24/2023
16.1.0-previ... 7 1/24/2023
16.1.0-previ... 14 1/22/2023
16.1.0-previ... 347 1/4/2023
16.1.0-previ... 8 1/3/2023
16.1.0-previ... 17 12/26/2022
16.1.0-previ... 52 12/19/2022
16.1.0-previ... 15 12/17/2022
16.1.0-previ... 117 12/11/2022
16.1.0-previ... 16 12/4/2022
16.1.0-previ... 39 11/26/2022
16.1.0-previ... 14 11/24/2022
16.0.1-previ... 33 11/11/2022
16.0.0 828,442 9/9/2022
16.0.0-previ... 32 8/21/2022
16.0.0-previ... 26 8/13/2022
16.0.0-previ... 18 8/13/2022
16.0.0-previ... 27 8/1/2022
16.0.0-previ... 84 6/14/2022
16.0.0-previ... 27 6/8/2022
16.0.0-previ... 19 6/6/2022
16.0.0-previ... 17 6/6/2022
16.0.0-previ... 92 4/26/2022
16.0.0-previ... 46 3/28/2022
16.0.0-previ... 68 2/12/2022
15.2.0 2,685,813 9/1/2021
15.2.0-previ... 20 9/1/2021
15.2.0-previ... 46 7/23/2021
15.2.0-previ... 77 6/6/2021
15.2.0-previ... 70 4/18/2021
15.2.0-previ... 88 3/12/2021
15.1.1 1,448,593 2/12/2021
15.1.1-previ... 20 2/12/2021
15.1.0 62,667 2/2/2021
15.1.0-previ... 27 2/1/2021
15.1.0-previ... 22 1/31/2021
15.0.2-previ... 21 1/30/2021
15.0.2-previ... 27 1/24/2021
15.0.2-previ... 66 1/21/2021
15.0.2-previ... 65 1/12/2021
15.0.1 143,085 1/9/2021
15.0.1-previ... 62 1/9/2021
15.0.1-previ... 67 1/6/2021
15.0.1-previ... 63 1/6/2021
15.0.1-previ... 72 12/27/2020
15.0.1-previ... 64 12/26/2020
15.0.1-previ... 66 12/23/2020
15.0.1-previ... 73 12/14/2020
15.0.1-previ... 65 12/13/2020
15.0.1-previ... 64 12/12/2020
15.0.1-previ... 64 12/10/2020
15.0.0 214,908 12/6/2020
15.0.0-previ... 64 12/6/2020
15.0.0-previ... 69 11/25/2020
15.0.0-previ... 61 11/22/2020
15.0.0-previ... 65 11/21/2020
14.3.0-previ... 102 10/5/2020
14.3.0-previ... 57 10/3/2020
14.3.0-previ... 64 10/2/2020
14.2.2-previ... 108 8/19/2020
14.2.2-previ... 65 8/16/2020
14.2.1 650,335 8/14/2020
14.2.1-previ... 62 8/13/2020
14.2.1-previ... 64 8/11/2020
14.2.1-previ... 60 8/11/2020
14.2.1-previ... 76 7/31/2020
14.2.1-previ... 63 7/28/2020
14.2.0 72,792 7/23/2020
14.2.0-previ... 66 7/23/2020
14.2.0-previ... 68 7/19/2020
14.2.0-previ... 77 7/13/2020
14.2.0-previ... 68 7/10/2020
14.2.0-previ... 65 7/9/2020
14.1.1-previ... 66 7/9/2020
14.1.0 221,834 7/6/2020
14.1.0-previ... 372 7/5/2020
14.1.0-previ... 64 7/4/2020
14.1.0-previ... 65 7/4/2020
14.1.0-previ... 66 7/3/2020
14.1.0-previ... 69 7/1/2020
14.0.1-previ... 75 6/28/2020
14.0.1-previ... 65 6/26/2020
14.0.0 10,853 6/12/2020
14.0.0-previ... 66 6/12/2020
14.0.0-previ... 71 6/11/2020
14.0.0-previ... 74 6/10/2020
14.0.0-previ... 73 6/10/2020
14.0.0-previ... 106 5/28/2020
14.0.0-previ... 80 5/25/2020
14.0.0-previ... 72 5/25/2020
14.0.0-previ... 83 5/19/2020
14.0.0-previ... 79 5/19/2020
14.0.0-previ... 85 5/17/2020
14.0.0-previ... 74 5/17/2020
14.0.0-previ... 72 5/16/2020
14.0.0-previ... (current version) 73 5/14/2020
14.0.0-previ... 75 5/13/2020
14.0.0-previ... 82 5/12/2020
14.0.0-previ... 72 5/12/2020
14.0.0-previ... 73 5/12/2020
14.0.0-previ... 86 5/8/2020
14.0.0-previ... 71 5/6/2020
14.0.0-previ... 77 5/5/2020
14.0.0-previ... 73 5/4/2020
14.0.0-previ... 73 5/3/2020
14.0.0-previ... 72 5/3/2020
14.0.0-previ... 86 4/27/2020
14.0.0-previ... 82 4/26/2020
13.5.0 28,499 4/12/2020
13.5.0-previ... 79 4/11/2020
13.5.0-previ... 82 4/11/2020
13.4.1-previ... 108 3/31/2020
13.4.0 122,355 3/18/2020
13.4.0-previ... 76 3/18/2020
13.3.1-previ... 120 1/18/2020
13.3.0 481,355 1/17/2020
13.3.0-previ... 78 1/17/2020
13.3.0-previ... 82 1/12/2020
13.3.0-previ... 77 1/8/2020
13.3.0-previ... 78 1/7/2020
13.3.0-previ... 77 1/3/2020
13.3.0-previ... 77 1/2/2020
13.3.0-previ... 78 1/2/2020
13.2.0.0 863,033 9/19/2019
13.1.0.0 35,057 8/8/2019
13.0.0.0 26,094 6/26/2019
12.5.0.0 17,610 5/15/2019
12.4.0.0 21,822 4/3/2019
12.3.0.0 40,238 2/20/2019
12.2.0.0 9,115 1/10/2019
12.1.0.0 23,379 10/25/2018
12.0.0.0 21,463 9/5/2018
11.4.0.0 16,164 7/25/2018
11.3.0.0 7,394 6/13/2018
11.2.0.0 5,691 5/2/2018
11.1.0.0 6,264 3/22/2018
11.0.0.0 13,553 2/8/2018
10.0.0.0 3,656 12/14/2017
Show less