SqlServerDsc

16.3.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.3.0

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

Install-PSResource -Name SqlServerDsc -Version 16.3.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

Owners

Copyright

Copyright the DSC Community contributors. All rights reserved.

Package Details

Author(s)

  • DSC Community

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-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.3.0] - 2023-04-26

### Remove

- SqlServerDsc.Common
 - Removed the function `Invoke-Query`. It is replaced by the command
   `Invoke-SqlDscQuery` ([issue #1902](https://github.com/dsccommunity/SqlServerDsc/issues/1902)).

### Added

- New public commands:
 - `Disconnect-SqlDscDatabaseEngine` - Disconnects from a SQL Server instance
   that was previously connected to using `Connect-SqlDscDatabaseEngine`.
 - `Test-SqlDscIsSupportedFeature` - Evaluates if a feature is supported by a specific
   Microsoft SQL Server major version. _This command must be extended with_
   _a full list of when features were added and removed in each major_
   _version to fully work_.
- New private commands:
 - `ConvertTo-RedactedText` - Used to redact sensitive information from
   text that then can be used in console output like verbose messages.
 - `Get-FileVersionInformation` - Returns the version information
   for a file.
 - `Assert-Feature` - Throws an exception if a feature is not supported
   for a specific Microsoft SQL Server major version.
- SqlServerDsc.Common
 - `Connect-SQL`.
   - Add new parameter `Encrypt`.
- `Connect-SqlDscDatabaseEngine`
 - Add new parameter `Encrypt`.
- `Invoke-SqlDscQuery`
 - Add new parameter `Encrypt`.

### Changed

- Now able to use [DbaTools](https://dbatools.io/) as a preferred module
 (with some restrictions).
- Gitversion no longer evaluates bumping major version using the word "major".
- Update private commands:
 - `Assert-SetupActionProperties` was changed to throw
   an exception when a feature is not supported (calls `Assert-Feature`).
   The private command is indirectly used by the setup action commands.
 - `Invoke-SetupAction` was changed to expand environment variables that
   is passed as the media path.
- SqlSetup
 - Update to support checking non-supported features using the command
   `SqlDscIsSupportedFeature` ([issue #1872](https://github.com/dsccommunity/SqlServerDsc/issues/1872)).
- Update SqlServerDsc.Common Module:
 - `Connect-SQL` - Function will now wait for the SMO Status property to be
   'Online' or throw an exception if time exceeds the statement timeout.
- SqlRS
 - Now uses the command `Invoke-SqlDscQuery` instead of `Invoke-SqlCmd`
  ([issue #1917](https://github.com/dsccommunity/SqlServerDsc/issues/1917)).
 - The parameter `Encrypt` has changed so that `Mandatory` or `Strict`
   will turn on encryption when connecting to the database instance.
- SqlDatabaseMail
 - Update integration tests to verify multiple instances of SqlDatabaseMail
   in the same configuration ([issue #1871](https://github.com/dsccommunity/SqlServerDsc/issues/1871)).
 - Changed comparison logic to use `Compare-DscParameterState` ([issue #1871](https://github.com/dsccommunity/SqlServerDsc/issues/1871)).
 - Return the correct profile name and mail server name from the current
   state ([issue #1871](https://github.com/dsccommunity/SqlServerDsc/issues/1871)).
- `Invoke-SqlDscQuery`
 - Now shows the correct instance name when called using a server object
   ([issue #1918](https://github.com/dsccommunity/SqlServerDsc/issues/1918)).
 - Correctly outputs query in verbose message when parameter `RedactText`
   is not passed.
- `Import-SqlDscPreferredModule`
 - Better handle preferred module and re-uses logic in `Get-SqlDscPreferredModule`.

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,851 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 (current version) 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... 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,611 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,855 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