SqlServerDsc

16.1.0-preview0016

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 16.1.0-preview0016 -AllowPrerelease

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

Install-PSResource -Name SqlServerDsc -Version 16.1.0-preview0016 -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

Functions

Add-SqlDscNode Complete-SqlDscFailoverCluster Complete-SqlDscImage Connect-SqlDscDatabaseEngine ConvertFrom-SqlDscDatabasePermission ConvertFrom-SqlDscServerPermission ConvertTo-SqlDscDatabasePermission ConvertTo-SqlDscServerPermission Disable-SqlDscAudit Enable-SqlDscAudit Get-SqlDscAudit Get-SqlDscDatabasePermission Get-SqlDscServerPermission Import-SqlDscPreferredModule Initialize-SqlDscRebuildDatabase Install-SqlDscServer Invoke-SqlDscQuery New-SqlDscAudit Remove-SqlDscAudit Remove-SqlDscNode Repair-SqlDscServer Set-SqlDscAudit Set-SqlDscDatabasePermission Set-SqlDscServerPermission Test-SqlDscIsDatabasePrincipal Test-SqlDscIsLogin 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.1.0-preview0016] - 2023-02-12

### Removed

- SqlServerDsc
 - Removed `Assert-ElevatedUser` from private functions ([issue #1797](https://github.com/dsccommunity/SqlServerDsc/issues/1797)).
   - `Assert-ElevatedUser` added to _DscResource.Common_ public functions
     ([issue #82](https://github.com/dsccommunity/DscResource.Common/issues/82)).
 - Removed `Test-IsNumericType` from private functions ([issue #1795](https://github.com/dsccommunity/SqlServerDsc/issues/1795)).
   - `Test-IsNumericType` added to _DscResource.Common_ public functions
   ([issue #87](https://github.com/dsccommunity/DscResource.Common/issues/87)).
 - Removed `Test-ServiceAccountRequirePassword` from private functions ([issue #1794](https://github.com/dsccommunity/SqlServerDsc/issues/1794)
   - Replaced by `Test-AccountRequirePassword` that was added to _DscResource.Common_
     public functions ([issue #93](https://github.com/dsccommunity/DscResource.Common/issues/93)).
 - Removed `Assert-RequiredCommandParameter` from private functions ([issue #1796](https://github.com/dsccommunity/SqlServerDsc/issues/1796)).
   - Replaced by `Assert-BoundParameter` (part of _DscResource.Common_)
     that had a new parameter set added ([issue #92](https://github.com/dsccommunity/DscResource.Common/issues/92)).
 - Removed private function `Test-ResourceDscPropertyIsAssigned` and
   `Test-ResourceHasDscProperty`. Both are replaced by `Test-DscProperty`
   which is now part of the module _DscResource.Common_.
 - Removed private function `Get-DscProperty`. It is replaced by `Get-DscProperty`
   which is now part of the module _DscResource.Common_.
 - The class `ResourceBase` and `Reason` has been removed, they are now
   part of the module _DscResource.Base_.
 - The enum `Ensure` has been removed, is is now part of the module
   _DscResource.Base_.
 - The private functions that the class `ResourceBase` depended on has been
   moved to the module _DscResource.Base_.
   - `ConvertFrom-CompareResult`
   - `ConvertTo-Reason`
   - `Get-ClassName`
   - `Get-LocalizedDataRecursive`
 - Added documentation how to generate stub modules for the unit tests.
   The documentation can be found in ['tests/Unit/Stubs`](https://github.com/dsccommunity/SqlServerDsc/tree/main/tests/Unit/Stubs).
 - SqlRSSetup and SqlRS
   - Removed the integration test when running against SQL Server 2019,
     due to the URL to download the Reporting Services 2019 executable
     no longer works.

### Added

- SqlServerDsc
 - The following private functions were added to the module (see comment-based
   help for more information):
   - `Assert-SetupActionProperties`
   - `Invoke-SetupAction`
 - The following public functions were added to the module (see comment-based
   help for more information):
   - `Install-SqlDscServer`
   - `Uninstall-SqlDscServer`
   - `Add-SqlDscNode`
   - `Remove-SqlDscNode`
   - `Repair-SqlDscServer`
   - `Complete-SqlDscImage`
   - `Complete-SqlDscFailoverCluster`
   - `Initialize-SqlDscRebuildDatabase`
   - `Import-SqlDscPreferredModule`
 - New GitHub issue templates for proposing new public commands, proposing
   an enhancement to an existing command, or having a problem with an existing
   command.
 - Integration tests are now also run on SQL Server 2022 and SQL Server
   Reporting Services 2022.
 - Integration tests now wait for LCM after each It-block, not just at the
   end of a Context-block. Hopefully this will mitigate some of the intermittent
   errors we have seen when running the integration tests in the pipeline.
 - Use preview version of Pester to support the development of Pester as
   this is a code base with a diverse set of tests thar can help catch
   issues in Pester. If preview release of Pester prevents release we
   should temporary shift back to stable.
 - Add the GitHub App _Pull Request Quantifier_ as an experiment to see if it
   brings any value ([issue #1811](https://github.com/dsccommunity/SqlServerDsc/issues/1811)).
   - Updated thresholds, and label names and colors.
 - New QA tests for public commands and private functions.
- SqlDatabase
 - Added compatibility levels for SQL Server 2022 (major version 16).
- SqlSetup
 - Paths for SQL Server 2022 are correctly returned by Get.
- SqlRS
 - Added optional parameter `Encrypt`. Parameter `Encrypt` controls whether
   the connection used by `Invoke-SqlCmd should enforce encryption. This
   parameter can only be used together with the module _SqlServer_ v22.x
   (minimum v22.0.49-preview). The parameter will be ignored if an older
   major versions of the module _SqlServer_ is used.
- SqlScript
 - Added optional parameter `Encrypt`. Parameter `Encrypt` controls whether
   the connection used by `Invoke-SqlCmd should enforce encryption. This
   parameter can only be used together with the module _SqlServer_ v22.x
   (minimum v22.0.49-preview). The parameter will be ignored if an older
   major versions of the module _SqlServer_ is used.
- SqlScriptQuery
 - Added optional parameter `Encrypt`. Parameter `Encrypt` controls whether
   the connection used by `Invoke-SqlCmd should enforce encryption. This
   parameter can only be used together with the module _SqlServer_ v22.x
   (minimum v22.0.49-preview). The parameter will be ignored if an older
   major versions of the module _SqlServer_ is used.
- SqlTraceFlag
 - The resource is now tested with an integration tests ([issue #1835](https://github.com/dsccommunity/SqlServerDsc/issues/1835)).
 - A new parameter `ClearAllTraceFlags` was added so a configuration
   can enforce that there should be no trace flags.
- The public commands `Add-SqlDscNode`, `Complete-SqlDscFailoverCluster`,
 `Complete-SqlDscImage`, `Install-SqlDscServer`, and `Repair-SqlDscServer`
 now support the setup argument `ProductCoveredBySA` ([issue #1798](https://github.com/dsccommunity/SqlServerDsc/issues/1798)).

### Changed

- SqlServerDsc
 - Update Stale GitHub Action to v7.
 - Update to build module in separate folder under `output`.
 - Moved the build step of the pipeline to a Windows build worker when
   running in Azure DevOps.
 - Class-based resources now uses the parent class `ResourceBase` from the
   module _DscResource.Base_ ([issue #1790](https://github.com/dsccommunity/SqlServerDsc/issues/1790)).
 - Settings for the _Visual Studio Code_ extension _Pester Tests_ was changed
   to be able to run all unit tests, and all tests run by the extension
   are now run in a separate process to be able to handle changes in
   class-based resources.
 - The AppVeyor configuration file was updated to include the possibility
   to run integration tests for SQL Server 2022.
 - The AppVeyor configuration file was updated to include the possibility
   to run skip installing one or more SQL Server instances when debugging
   in AppVeyor to help maximize the time alloted be run.
 - The stubs in `SqlServerStub.psm1` are now based on the commands from the
   module SqlServer v22.0.49-preview.
 - The module will now call `Import-SqlDscPreferredModule` when the module
   is imported to make sure SqlServer (default preferred module) or SQLPS
   is loaded into the session. This will make it possible for classes and
   commands to use and return SQL types. If no module is found it will
   output a warning to install any of the dependent modules.
- `Install-SqlServerDsc`
 - No longer throws an exception when parameter `AgtSvcAccount` is not specified.
- SqlAgReplica
 - Converted unit test to Pester 5.
 - `Update-AvailabilityGroupReplica` to trigger once within `Set-TargetResource`
   for all AvailabilityReplica changes.
- Private function `Invoke-SetupAction` ([issue #1798](https://github.com/dsccommunity/SqlServerDsc/issues/1798)).
 - Was changed to support the SQL Server 2022 GA feature `AzureExtension`
   (that replaced the feature name `ARC`).
 - Support the setup argument `ProductCoveredBySA`.
 - No longer supports the argument `OnBoardSQLToARC` as it was removed in
   SQL Server 2022 GA.
- `Install-SqlDscServer`
 - Was changed to support the SQL Server 2022 GA feature `AzureExtension`
   (that replaced the feature name `ARC`) ([issue #1798](https://github.com/dsccommunity/SqlServerDsc/issues/1798)).
- `Uninstall-SqlDscServer`
 - Was changed to support the SQL Server 2022 GA feature `AzureExtension`
   (that replaced the feature name `ARC`) ([issue #1798](https://github.com/dsccommunity/SqlServerDsc/issues/1798)).
- `Import-SqlDscPreferredModule`
 - No longer tries to get the environment variables from the machine state
   when run on Linux or macOS. This will allow the unit tests to run
   cross-plattform.
- SqlReplication
 - The resource now supports SQL Server 2022. The resource will require
   the module _SqlServer_ v22.0.49-preview or newer when used against an
   SQL Server 2022 instance ([issue #1801](https://github.com/dsccommunity/SqlServerDsc/issues/1801)).
- SqlProtocol
 - The resource now supports SQL Server 2022. The resource will require
   the module _SqlServer_ v22.0.49-preview or newer when used against an
   SQL Server 2022 instance ([issue #1802](https://github.com/dsccommunity/SqlServerDsc/issues/1802)).
- SqlProtocolTcpIp
 - The resource now supports SQL Server 2022. The resource will require
   the module _SqlServer_ v22.0.49-preview or newer when used against an
   SQL Server 2022 instance ([issue #1805](https://github.com/dsccommunity/SqlServerDsc/issues/1805)).
- SqlServiceAccount
 - The resource now supports SQL Server 2022. The resource will require
   the module _SqlServer_ v22.0.49-preview or newer when used against an
   SQL Server 2022 instance ([issue #1800](https://github.com/dsccommunity/SqlServerDsc/issues/1800)).
- SqlSetup
 - Integration test

FileList

Version History

Version Downloads Last updated
17.3.0-previ... 5 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 169,297 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,737 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,423,532 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,187 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,804 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... (current version) 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,432 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,806 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,428 2/12/2021
15.1.1-previ... 20 2/12/2021
15.1.0 62,666 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,332 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... 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,354 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,028 9/19/2019
13.1.0.0 35,054 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,690 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