SqlServerDsc

16.0.0-preview0008

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.0.0-preview0008 -AllowPrerelease

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

Install-PSResource -Name SqlServerDsc -Version 16.0.0-preview0008 -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 SqlConfiguration SqlDatabase SqlDatabaseDefaultLocation SqlDatabaseMail SqlDatabaseObjectPermission SqlDatabasePermission SqlDatabaseRole SqlDatabaseUser SqlEndpoint SqlEndpointPermission SqlLogin SqlMaxDop SqlMemory SqlPermission SqlProtocol SqlProtocolTcpIp SqlReplication SqlRole SqlRS SqlRSSetup SqlScript SqlScriptQuery SqlSecureConnection SqlServiceAccount SqlSetup SqlTraceFlag SqlWaitForAG SqlWindowsFirewall

Dependencies

This module has no dependencies.

Release Notes

## [16.0.0-preview0008] - 2022-06-08

### Removed

- The deprecated DSC resource SqlDatabaseOwner have been removed _(and replaced_
 _by a property in [**SqlDatabase**](https://github.com/dsccommunity/SqlServerDsc/wiki/sqldatabase))_
 ([issue #1725](https://github.com/dsccommunity/SqlServerDsc/issues/1725)).
- The deprecated DSC resource SqlDatabaseRecoveryModel have been removed _(and_
 _replaced by a property in [**SqlDatabase**](https://github.com/dsccommunity/SqlServerDsc/wiki/sqldatabase))_
 ([issue #1725](https://github.com/dsccommunity/SqlServerDsc/issues/1725)).
- The deprecated DSC resource SqlServerEndpointState have been removed _(and_
 _replaced by a property in [**SqlEndpoint**](https://github.com/dsccommunity/SqlServerDsc/wiki/sqlendpoint))_
 ([issue #1725](https://github.com/dsccommunity/SqlServerDsc/issues/1725)).
- The deprecated DSC resource SqlServerNetwork have been removed _(and replaced by_
 _[**SqlProtocol**](https://github.com/dsccommunity/SqlServerDsc/wiki/sqlprotocol)_
 _and [**SqlProtocolTcpIp**](https://github.com/dsccommunity/SqlServerDsc/wiki/sqlprotocoltcpip))_
 ([issue #1725](https://github.com/dsccommunity/SqlServerDsc/issues/1725)).
- CommonTestHelper
 - Remove the helper function `Wait-ForIdleLcm` since it has been moved
   to the module _DscResource.Test_.
 - Remove the helper function `Get-InvalidOperationRecord` since it has
   been moved to the module _DscResource.Test_.
 - Remove the helper function `Get-InvalidResultRecord` since it has been
   moved to the module _DscResource.Test_.

### Added

- SqlServerDsc
 - Added recommended VS Code extensions.
   - Added settings for VS Code extension _Pester Test Adapter_.
- CommonTestHelper
 - `Import-SqlModuleStub`
   - Added the optional parameter **PasThru** that, if used, will return the
     name of the stub module.
   - When removing stub modules from the session that is not supposed to
     be loaded, it uses `Get-Module -All` to look for previously loaded
     stub modules.
 - `Remove-SqlModuleStub`
   - Added a new helper function `Remove-SqlModuleStub` for tests to remove
     the PowerShell SqlServer stub module when a test has run.
- SqlWindowsFirewall
 - Added integration tests for SqlWindowsFirewall ([issue #747](https://github.com/dsccommunity/SqlServerDsc/issues/747)).

### Changed

- SqlServerDsc
 - Updated pipeline to use the build worker image 'ubuntu-latest'.
 - Switch to installing GitVersion using 'dotnet tool install' ([issue #1732](https://github.com/dsccommunity/SqlServerDsc/issues/1732)).
 - Bumped Stale task to v5 in the GitHub workflow.
 - Make it possible to publish code coverage on failed test runs, and
   when re-run a fail job.
- Wiki
 - add introduction and links to DSC technology
- SqlLogin
 - BREAKING CHANGE: The parameters `LoginMustChangePassword`, `LoginPasswordExpirationEnabled`,
   and `LoginPasswordPolicyEnforced` no longer have a default value of `$true`.
   This means that when creating a new login, and not specifically setting
   these parameters to `$true` in the configuration, the login that is created
   will have these properties set to `$false`.
 - BREAKING CHANGE: `LoginMustChangePassword`, `LoginPasswordExpirationEnabled`,
   and `LoginPasswordPolicyEnforced` parameters no longer enforce default
   values ([issue #1669](https://github.com/dsccommunity/SqlServerDsc/issues/1669)).
- SqlServerDsc
 - All tests have been converted to run in Pester 5 (Pester 4 can no
   longer be supported) ([issue #1654](https://github.com/dsccommunity/SqlServerDsc/issues/1654)).
 - Pipeline build and deploy now runs on Ubuntu 18.04, see more information
   in https://github.com/actions/virtual-environments/issues/3287.
 - Update the pipeline file _azure-pipelines.yml_ to use the latest version
   from the Sampler project.
- SqlRs
 - BREAKING CHANGE: Now the Reporting Services is always restarted after
   the call to CIM method `SetDatabaseConnection` when setting up the
   Reporting Services. This so to try to finish the initialization of
   Reporting Services. This was prior only done for _SQL Server Reporting_
   _Services 2019_ ([issue #1721](https://github.com/dsccommunity/SqlServerDsc/issues/1721)).
 - Added some verbose messages to better indicate which CIM methods are run
   and when they are run.
 - Minor refactor to support running unit test with strict mode enabled.
- SqlLogin
 - Only enforces optional parameter `LoginType` when it is specified in the
   configuration.
 - Only enforces optional parameters `LoginPasswordExpirationEnabled` and
   `LoginPasswordPolicyEnforced` for a SQL login when the parameters are
   specified in the configuration.
 - A localized string for an error message was updated to correctly reflect
   the code that says that to use a SQL login the authentication mode must
   be either Mixed or Normal, prio it just stated Mixed.
- SqlSecureConnection
 - BREAKING CHANGE: Now `Get-TargetResource` returns the value `'Empty'`
   for the property thumbprint if there is no thumbprint set in the current
   state. Returning the value `'Empty'` was always intended, but it due to
   a bug it was never returned, but instead it returned an empty string
   or `$null` value.
- SqlWindowsFirewall
 - Now the property Features always return the features in the order
   'SQLENGINE', 'RS', 'AS', and 'IS' if they are installed.
- SqlAGListener
 - Removed unnecessary exception that is very unlikely to be thrown in
   `Set-TargetResource` and `Test-TargetResource`.
 - Simplified the logic that checks if the properties are in desired state
   as the new unit tests did not pass with the previous logic.
 - Updated the verbose message when the listener does not exist to write
   out the name of the listener that is meant to be updated, added, or
   dropped.
 - Only update values for the properties that are actually enforced by the
   configuration.
- SqlAGDatabase
 - Added StatementTimeout optional parameter with default value of 600 seconds (10 mins) to SqlAGDatabase to fix Issue#1743
   Users will be able to specify the backup and restore timeout with it.
- SqlDatabaseUser
 - `Test-TargetResource` returns true if the `IsUpdateable` property of the database is `$false` to resolve Issue#1748.
- SqlDatabaseRole
 - `Test-TargetResource` returns true if the `IsUpdateable` property of the database is `$false` to resolve Issue#1750.

### Fixed

- SqlServerDsc
 - URLs the referenced TechNet in the documentation has been update to link to
   new pages at docs.microsoft.com.
 - Fix pipeline so code coverage is published on fail.
- CommonTestHelper
 - The test helper function `Import-SqlModuleStub` was using wrong casing for
   one of the stub  modules which failed test when running cross plattform.
- SqlDatabaseObjectPermission
 - Fix for issue ([issue #1724](https://github.com/dsccommunity/SqlServerDsc/issues/1724)).
   - BREAKING CHANGE: Updated class DSC_DatabaseObjectPermission.
     - Changed Permission from an array to a string.
     - Updated Permission to a key property.
     - Updated Integration Tests to test permission grants on multiple objects.
- SqlProtocolTcpIp
 - Output verbose information in integration tests so it is shown what NICs
   are available and what IP address the tests will use.
- SqlAlias
 - Now the code passes strict mode during unit testing.
 - When an existing alias existed with a static TCP port but the desired
   state was to have a dynamic port, the function `Test-TargetResource` did
   not correctly return `$false`. Same for an alias that existed with a
   dynamic port but the desired state was to have a static port. Now the
   function `Test-TargetResource` returns `$false` in both these scenarios.
- SqlAgentOperator
 - In a certain case the `Test-TargetResource` function returned the wrong
   verbose message. If passing an e-mail address and the operator did not
   exist it would wrongly say operator exist but had wrong e-mail address.
   Truth was that the operator did not exist at all.
- SqlDatabaseMail
 - Improved the verification of an empty description so that it can handle
   both empty string and `$null`.
- SqlDatabaseRole
 - Some variables where not initialized correctly which was discovered when
   running the unit tests using strict mode. Now the variables are initialized
   and should not cause any issues in the object returned from the function
   `Get-TargetResource`.
- SqlEndpointPermission
 - Verbose messages did not use the correct variable name, so the messages
   did not contain the correct information.
 - Minor style guideline changes.
- SqlMaxDop
 - The function `Get-TargetResource` did not initialize some of the variables
   correctly which was discovered when running the unit tests using strict
   mode.
 - The function `Test-TargetResource` did not correctly evaluate if the
   node was the active node..
- SqlMemory
 - Now it possible to just set the minimum memory without it throwing because
   the maximum memory is not specified.
 - In a certain scenario the maximum memory would be enforced even if it was
   not specified in the configuration.
- SqlWindowsFirewall
 - Now the variables in `Get-TargetResource` are correctly initialized so
   they pass the new unit test that use strict mode.
 - The verbose message in `Test-TargetResource` did not use the correct
   variable name, so the message did not contain the correct information.
 - Removed unnecessary logic in `Set-TargetResource` that did just evaluated
   the same thing that the call to function `Get-TargetResource` already
   does.
- SqlSetup
 - Now the variables in `Set-TargetResource` are correctly initialized so
   they pass the new unit test that use strict mode.
 - Some ver

FileList

Version History

Version Downloads Last updated
17.0.1-previ... 17 10/29/2024
17.0.1-previ... 6 10/26/2024
17.0.1-previ... 14 10/7/2024
17.0.0 40,228 9/30/2024
17.0.0-previ... 4 9/29/2024
17.0.0-previ... 48 8/13/2024
16.6.1-previ... 118 5/23/2024
16.6.1-previ... 5 5/22/2024
16.6.0 91,058 5/17/2024
16.6.0-previ... 10 5/12/2024
16.6.0-previ... 4 5/11/2024
16.6.0-previ... 104 3/3/2024
16.6.0-previ... 46 1/20/2024
16.6.0-previ... 6 1/19/2024
16.5.1-previ... 68 12/15/2023
16.5.1-previ... 91 11/19/2023
16.5.1-previ... 47 11/2/2023
16.5.0 144,721 10/5/2023
16.5.0-previ... 12 10/1/2023
16.5.0-previ... 7 9/29/2023
16.5.0-previ... 47 9/1/2023
16.5.0-previ... 7 8/26/2023
16.4.1-previ... 6 8/25/2023
16.4.0 111,489 8/22/2023
16.4.0-previ... 5 8/20/2023
16.4.0-previ... 5 8/20/2023
16.4.0-previ... 6 8/19/2023
16.4.0-previ... 76 5/18/2023
16.4.0-previ... 20 5/10/2023
16.4.0-previ... 6 5/9/2023
16.4.0-previ... 7 5/8/2023
16.3.1 460,073 5/6/2023
16.3.1-previ... 5 5/6/2023
16.3.1-previ... 9 5/4/2023
16.3.0 42,245 4/26/2023
16.3.0-previ... 7 4/26/2023
16.3.0-previ... 7 4/25/2023
16.3.0-previ... 6 4/24/2023
16.3.0-previ... 6 4/23/2023
16.3.0-previ... 21 4/18/2023
16.3.0-previ... 5 4/16/2023
16.2.1-previ... 7 4/12/2023
16.2.0 75,151 4/10/2023
16.2.0-previ... 5 4/10/2023
16.2.0-previ... 5 4/8/2023
16.2.0-previ... 5 4/8/2023
16.2.0-previ... 10 4/6/2023
16.2.0-previ... 10 4/1/2023
16.2.0-previ... 11 3/28/2023
16.2.0-previ... 10 3/26/2023
16.2.0-previ... 5 3/25/2023
16.2.0-previ... 170 3/19/2023
16.2.0-previ... 27 3/7/2023
16.2.0-previ... 10 3/4/2023
16.1.0 175,566 2/28/2023
16.1.0-previ... 6 2/28/2023
16.1.0-previ... 9 2/25/2023
16.1.0-previ... 6 2/24/2023
16.1.0-previ... 48 2/13/2023
16.1.0-previ... 28 2/12/2023
16.1.0-previ... 25 2/5/2023
16.1.0-previ... 11 2/1/2023
16.1.0-previ... 29 1/25/2023
16.1.0-previ... 8 1/24/2023
16.1.0-previ... 5 1/24/2023
16.1.0-previ... 12 1/22/2023
16.1.0-previ... 346 1/4/2023
16.1.0-previ... 6 1/3/2023
16.1.0-previ... 15 12/26/2022
16.1.0-previ... 50 12/19/2022
16.1.0-previ... 13 12/17/2022
16.1.0-previ... 115 12/11/2022
16.1.0-previ... 13 12/4/2022
16.1.0-previ... 36 11/26/2022
16.1.0-previ... 11 11/24/2022
16.0.1-previ... 31 11/11/2022
16.0.0 827,595 9/9/2022
16.0.0-previ... 30 8/21/2022
16.0.0-previ... 24 8/13/2022
16.0.0-previ... 15 8/13/2022
16.0.0-previ... 26 8/1/2022
16.0.0-previ... 81 6/14/2022
16.0.0-previ... (current version) 25 6/8/2022
16.0.0-previ... 18 6/6/2022
16.0.0-previ... 15 6/6/2022
16.0.0-previ... 89 4/26/2022
16.0.0-previ... 45 3/28/2022
16.0.0-previ... 66 2/12/2022
15.2.0 2,684,609 9/1/2021
15.2.0-previ... 16 9/1/2021
15.2.0-previ... 45 7/23/2021
15.2.0-previ... 76 6/6/2021
15.2.0-previ... 66 4/18/2021
15.2.0-previ... 86 3/12/2021
15.1.1 1,391,851 2/12/2021
15.1.1-previ... 18 2/12/2021
15.1.0 62,442 2/2/2021
15.1.0-previ... 25 2/1/2021
15.1.0-previ... 20 1/31/2021
15.0.2-previ... 19 1/30/2021
15.0.2-previ... 25 1/24/2021
15.0.2-previ... 63 1/21/2021
15.0.2-previ... 62 1/12/2021
15.0.1 143,076 1/9/2021
15.0.1-previ... 59 1/9/2021
15.0.1-previ... 64 1/6/2021
15.0.1-previ... 60 1/6/2021
15.0.1-previ... 69 12/27/2020
15.0.1-previ... 61 12/26/2020
15.0.1-previ... 63 12/23/2020
15.0.1-previ... 71 12/14/2020
15.0.1-previ... 62 12/13/2020
15.0.1-previ... 60 12/12/2020
15.0.1-previ... 61 12/10/2020
15.0.0 214,513 12/6/2020
15.0.0-previ... 61 12/6/2020
15.0.0-previ... 66 11/25/2020
15.0.0-previ... 58 11/22/2020
15.0.0-previ... 62 11/21/2020
14.3.0-previ... 99 10/5/2020
14.3.0-previ... 55 10/3/2020
14.3.0-previ... 61 10/2/2020
14.2.2-previ... 105 8/19/2020
14.2.2-previ... 61 8/16/2020
14.2.1 642,161 8/14/2020
14.2.1-previ... 60 8/13/2020
14.2.1-previ... 61 8/11/2020
14.2.1-previ... 57 8/11/2020
14.2.1-previ... 72 7/31/2020
14.2.1-previ... 60 7/28/2020
14.2.0 72,592 7/23/2020
14.2.0-previ... 63 7/23/2020
14.2.0-previ... 65 7/19/2020
14.2.0-previ... 74 7/13/2020
14.2.0-previ... 65 7/10/2020
14.2.0-previ... 62 7/9/2020
14.1.1-previ... 64 7/9/2020
14.1.0 221,770 7/6/2020
14.1.0-previ... 369 7/5/2020
14.1.0-previ... 61 7/4/2020
14.1.0-previ... 62 7/4/2020
14.1.0-previ... 64 7/3/2020
14.1.0-previ... 66 7/1/2020
14.0.1-previ... 72 6/28/2020
14.0.1-previ... 61 6/26/2020
14.0.0 10,843 6/12/2020
14.0.0-previ... 62 6/12/2020
14.0.0-previ... 68 6/11/2020
14.0.0-previ... 70 6/10/2020
14.0.0-previ... 69 6/10/2020
14.0.0-previ... 103 5/28/2020
14.0.0-previ... 78 5/25/2020
14.0.0-previ... 68 5/25/2020
14.0.0-previ... 80 5/19/2020
14.0.0-previ... 76 5/19/2020
14.0.0-previ... 82 5/17/2020
14.0.0-previ... 71 5/17/2020
14.0.0-previ... 69 5/16/2020
14.0.0-previ... 70 5/14/2020
14.0.0-previ... 72 5/13/2020
14.0.0-previ... 80 5/12/2020
14.0.0-previ... 70 5/12/2020
14.0.0-previ... 70 5/12/2020
14.0.0-previ... 83 5/8/2020
14.0.0-previ... 69 5/6/2020
14.0.0-previ... 73 5/5/2020
14.0.0-previ... 71 5/4/2020
14.0.0-previ... 70 5/3/2020
14.0.0-previ... 69 5/3/2020
14.0.0-previ... 84 4/27/2020
14.0.0-previ... 79 4/26/2020
13.5.0 28,415 4/12/2020
13.5.0-previ... 76 4/11/2020
13.5.0-previ... 78 4/11/2020
13.4.1-previ... 105 3/31/2020
13.4.0 122,350 3/18/2020
13.4.0-previ... 71 3/18/2020
13.3.1-previ... 117 1/18/2020
13.3.0 480,496 1/17/2020
13.3.0-previ... 74 1/17/2020
13.3.0-previ... 79 1/12/2020
13.3.0-previ... 73 1/8/2020
13.3.0-previ... 76 1/7/2020
13.3.0-previ... 73 1/3/2020
13.3.0-previ... 74 1/2/2020
13.3.0-previ... 75 1/2/2020
13.2.0.0 861,904 9/19/2019
13.1.0.0 35,024 8/8/2019
13.0.0.0 26,042 6/26/2019
12.5.0.0 17,394 5/15/2019
12.4.0.0 21,746 4/3/2019
12.3.0.0 40,231 2/20/2019
12.2.0.0 9,018 1/10/2019
12.1.0.0 23,280 10/25/2018
12.0.0.0 21,441 9/5/2018
11.4.0.0 16,156 7/25/2018
11.3.0.0 7,383 6/13/2018
11.2.0.0 5,232 5/2/2018
11.1.0.0 6,228 3/22/2018
11.0.0.0 13,489 2/8/2018
10.0.0.0 3,650 12/14/2017
Show less