SqlServerDsc

11.0.0.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 11.0.0.0

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

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

(c) 2018 Microsoft Corporation. All rights reserved.

Package Details

Author(s)

  • Microsoft Corporation

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

DSCResources

SqlAG SqlAGDatabase SqlAGListener SqlAGReplica SqlAlias SqlAlwaysOnService SqlDatabase SqlDatabaseDefaultLocation SqlDatabaseOwner SqlDatabasePermission SqlDatabaseRecoveryModel SqlDatabaseRole SqlRS SqlScript SqlServerConfiguration SqlServerDatabaseMail SqlServerEndpoint SqlServerEndpointPermission SqlServerEndpointState SqlServerLogin SqlServerMaxDop SqlServerMemory SqlServerNetwork SqlServerPermission SqlServerReplication SqlServerRole SqlServiceAccount SqlSetup SqlWaitForAG SqlWindowsFirewall

Dependencies

This module has no dependencies.

Release Notes

- Changes to SqlServerDsc
 - BREAKING CHANGE: Resource SqlRSSecureConnectionLevel was remove
   ([issue 990](https://github.com/PowerShell/SqlServerDsc/issues/990)).
   The parameter that was set using that resource has been merged into resource
   SqlRS as the parameter UseSsl. The UseSsl parameter is of type boolean. This
   change was made because from SQL Server 2008 R2 this value is made an on/off
   switch. Read more in the article [ConfigurationSetting Method - SetSecureConnectionLevel](https://docs.microsoft.com/en-us/sql/reporting-services/wmi-provider-library-reference/configurationsetting-method-setsecureconnectionlevel).
 - Updated so that named parameters are used for New-Object cmdlet. This was
   done to follow the style guideline.
 - Updated manifest and license to reflect the new year
   ([issue 965](https://github.com/PowerShell/SqlServerDsc/issues/965)).
 - Added a README.md under Tests\Integration to help contributors to write
   integration tests.
 - Added "Integration tests" section in the CONTRIBUTING.md.
 - The complete examples were removed. They were no longer accurate and some
   referenced resources that no longer exist. Accurate examples can be found
   in each specific resource example folder. Examples for installing Failover Cluster
   can be found in the resource examples folders in the xFailOverCluster
   resource module ([issue 462](https://github.com/PowerShell/SqlServerDsc/issues/462)).
 - A README.md was created under the Examples folder to be used as reference how
   to install certain scenarios ([issue 462](https://github.com/PowerShell/SqlServerDsc/issues/462)).
 - Removed the local specific common test for compiling examples in this repository
   and instead opted-in for the common test in the "DscResource.Tests" repository
   ([issue 669](https://github.com/PowerShell/SqlServerDsc/issues/669)).
 - Added new resource SqlServerDatabaseMail for configuring SQL Server
   Database Mail ([issue 155](https://github.com/PowerShell/SqlServerDsc/issues/155)).
 - Updated the helper function Test-SQLDscParameterState to handle the
   data type UInt16.
 - Fixed typo in SqlServerDscCommon.Tests.
 - Updated README.md with known issue section for each resource.
 - Resources that did not have a description in the README.md now has one.
 - Resources that missed links to the examples in the README.md now has those
   links.
 - Style changes in all examples, removing type [System.Management.Automation.Credential()]
   from credential parameters ([issue 1003](https://github.com/PowerShell/SqlServerDsc/issues/1003)),
   and renamed the credential parameter so it is not using abbreviation.
 - Updated the security token for AppVeyor status badge in README.md. When we
   renamed the repository the security token was changed
   ([issue 1012](https://github.com/PowerShell/SqlServerDsc/issues/1012)).
 - Now the helper function Restart-SqlService, after restarting the SQL Server
   service, does not return until it can connect to the SQL Server instance, and
   the instance returns status "Online" ([issue 1008](https://github.com/PowerShell/SqlServerDsc/issues/1008)).
   If it fails to connect within the timeout period (defaults to 120 seconds) it
   throws an error.
 - Fixed typo in comment-base help for helper function Test-AvailabilityReplicaSeedingModeAutomatic.
 - Style cleanup in helper functions and tests.
- Changes to SqlAG
 - Fixed typos in tests.
 - Style cleanup in code and tests.
- Changes to SqlAGDatabase
 - Style cleanup in code and tests.
- Changes to SqlAGListener
 - Fixed typo in comment-based help.
 - Style cleanup in code and tests.
- Changes to SqlAGReplica
 - Minor code style cleanup. Removed unused variable and instead piped the cmdlet
   Join-SqlAvailabilityGroup to Out-Null.
 - Fixed minor typos in comment-based help.
 - Fixed minor typos in comment.
 - Style cleanup in code and tests.
 - Updated description for parameter Name in README.md and in comment-based help
   ([issue 1034](https://github.com/PowerShell/SqlServerDsc/issues/1034)).
- Changes to SqlAlias
 - Fixed issue where exception was thrown if reg keys did not exist
   ([issue 949](https://github.com/PowerShell/SqlServerDsc/issues/949)).
 - Style cleanup in tests.
- Changes to SqlAlwaysOnService
 - Refactor integration tests slightly to improve run time performance
   ([issue 1001](https://github.com/PowerShell/SqlServerDsc/issues/1001)).
 - Style cleanup in code and tests.
- Changes to SqlDatabase
 - Fix minor Script Analyzer warning.
- Changes to SqlDatabaseDefaultLocation
 - Refactor integration tests slightly to improve run time performance
   ([issue 1001](https://github.com/PowerShell/SqlServerDsc/issues/1001)).
 - Minor style cleanup of code in tests.
- Changes to SqlDatabaseRole
 - Style cleanup in tests.
- Changes to SqlRS
 - Replaced Get-WmiObject with Get-CimInstance to fix Script Analyzer warnings
   ([issue 264](https://github.com/PowerShell/SqlServerDsc/issues/264)).
 - Refactored the resource to use Invoke-CimMethod.
 - Added parameter UseSsl which when set to $true forces connections to the
   Reporting Services to use SSL when connecting ([issue 990](https://github.com/PowerShell/SqlServerDsc/issues/990)).
 - Added complete example for SqlRS (based on the integration tests)
   ([issue 634](https://github.com/PowerShell/SqlServerDsc/issues/634)).
 - Refactor integration tests slightly to improve run time performance
   ([issue 1001](https://github.com/PowerShell/SqlServerDsc/issues/1001)).
 - Style cleanup in code and tests.
- Changes to SqlScript
 - Style cleanup in tests.
 - Updated examples.
 - Added integration tests.
 - Fixed minor typos in comment-based help.
 - Added new example based on integration test.
- Changes to SqlServerConfiguration
 - Fixed minor typos in comment-based help.
 - Now the verbose message say what option is changing and to what value
   ([issue 1014](https://github.com/PowerShell/SqlServerDsc/issues/1014)).
 - Changed the RestartTimeout parameter from type SInt32 to type UInt32.
 - Added localization ([issue 605](https://github.com/PowerShell/SqlServerDsc/issues/605)).
 - Style cleanup in code and tests.
- Changes to SqlServerEndpoint
 - Updated README.md with links to the examples
   ([issue 504](https://github.com/PowerShell/SqlServerDsc/issues/504)).
 - Style cleanup in tests.
- Changes to SqlServerLogin
 - Added integration tests ([issue 748](https://github.com/PowerShell/SqlServerDsc/issues/748)).
 - Minor code style cleanup.
 - Removed unused variable and instead piped the helper function Connect-SQL to
   Out-Null.
 - Style cleanup in tests.
- Changes to SqlServerMaxDop
 - Minor style changes in the helper function Get-SqlDscDynamicMaxDop.
- Changes to SqlServerMemory
 - Style cleanup in code and tests.
- Changes to SqlServerPermission
 - Fixed minor typos in comment-based help.
 - Style cleanup in code.
- Changes to SqlServerReplication
 - Fixed minor typos in verbose messages.
 - Style cleanup in tests.
- Changes to SqlServerNetwork
 - Added sysadmin account parameter usage to the examples.
- Changes to SqlServerReplication
 - Fix Script Analyzer warning ([issue 263](https://github.com/PowerShell/SqlServerDsc/issues/263)).
- Changes to SqlServerRole
 - Added localization ([issue 621](https://github.com/PowerShell/SqlServerDsc/issues/621)).
 - Added integration tests ([issue 756](https://github.com/PowerShell/SqlServerDsc/issues/756)).
 - Updated example to add two server roles in the same configuration.
 - Style cleanup in tests.
- Changes to SqlServiceAccount
 - Default services are now properly detected
   ([issue 930](https://github.com/PowerShell/SqlServerDsc/issues/930)).
 - Made the description of parameter RestartService more descriptive
   ([issue 960](https://github.com/PowerShell/SqlServerDsc/issues/960)).
 - Added a read-only parameter ServiceAccountName so that the service account
   name is correctly returned as a string ([issue 982](https://github.com/PowerShell/SqlServerDsc/issues/982)).
 - Added integration tests ([issue 980](https://github.com/PowerShell/SqlServerDsc/issues/980)).
 - The timing issue that the resource returned before SQL Server service was
   actually restarted has been solved by a change in the helper function
   Restart-SqlService ([issue 1008](https://github.com/PowerShell/SqlServerDsc/issues/1008)).
   Now Restart-SqlService waits for the instance to return status "Online" or
   throws an error saying it failed to connect within the timeout period.
 - Style cleanup in code and tests.
- Changes to SqlSetup
 - Added parameter `ASServerMode` to support installing Analysis Services in
   Multidimensional mode, Tabular mode and PowerPivot mode
   ([issue 388](https://github.com/PowerShell/SqlServerDsc/issues/388)).
 - Added integration tests for testing Analysis Services Multidimensional mode
   and Tabular mode.
 - Cleaned up integration tests.
 - Added integration tests for installing a default instance of Database Engine.
 - Refactor integration tests slightly to improve run time performance
   ([issue 1001](https://github.com/PowerShell/SqlServerDsc/issues/1001)).
 - Added PSSA rule "PSUseDeclaredVarsMoreThanAssignments" override in the
   function Set-TargetResource for the variable $global:DSCMachineStatus.
 - Style cleanup in code and tests.
- Changes to SqlWaitForAG
 - Style cleanup in code.
- Changes to SqlWindowsFirewall
 - Fixed minor typos in comment-based help.
 - Style cleanup in code.

FileList

Version History

Version Downloads Last updated
16.6.0-previ... 70 3/3/2024
16.6.0-previ... 45 1/20/2024
16.6.0-previ... 5 1/19/2024
16.5.1-previ... 67 12/15/2023
16.5.1-previ... 90 11/19/2023
16.5.1-previ... 46 11/2/2023
16.5.0 133,715 10/5/2023
16.5.0-previ... 11 10/1/2023
16.5.0-previ... 6 9/29/2023
16.5.0-previ... 46 9/1/2023
16.5.0-previ... 6 8/26/2023
16.4.1-previ... 5 8/25/2023
16.4.0 111,239 8/22/2023
16.4.0-previ... 4 8/20/2023
16.4.0-previ... 4 8/20/2023
16.4.0-previ... 5 8/19/2023
16.4.0-previ... 75 5/18/2023
16.4.0-previ... 19 5/10/2023
16.4.0-previ... 5 5/9/2023
16.4.0-previ... 6 5/8/2023
16.3.1 459,303 5/6/2023
16.3.1-previ... 4 5/6/2023
16.3.1-previ... 8 5/4/2023
16.3.0 42,099 4/26/2023
16.3.0-previ... 6 4/26/2023
16.3.0-previ... 5 4/25/2023
16.3.0-previ... 5 4/24/2023
16.3.0-previ... 5 4/23/2023
16.3.0-previ... 20 4/18/2023
16.3.0-previ... 4 4/16/2023
16.2.1-previ... 6 4/12/2023
16.2.0 74,982 4/10/2023
16.2.0-previ... 4 4/10/2023
16.2.0-previ... 4 4/8/2023
16.2.0-previ... 4 4/8/2023
16.2.0-previ... 9 4/6/2023
16.2.0-previ... 9 4/1/2023
16.2.0-previ... 10 3/28/2023
16.2.0-previ... 9 3/26/2023
16.2.0-previ... 4 3/25/2023
16.2.0-previ... 169 3/19/2023
16.2.0-previ... 26 3/7/2023
16.2.0-previ... 9 3/4/2023
16.1.0 175,448 2/28/2023
16.1.0-previ... 5 2/28/2023
16.1.0-previ... 8 2/25/2023
16.1.0-previ... 5 2/24/2023
16.1.0-previ... 47 2/13/2023
16.1.0-previ... 27 2/12/2023
16.1.0-previ... 24 2/5/2023
16.1.0-previ... 10 2/1/2023
16.1.0-previ... 28 1/25/2023
16.1.0-previ... 7 1/24/2023
16.1.0-previ... 4 1/24/2023
16.1.0-previ... 11 1/22/2023
16.1.0-previ... 345 1/4/2023
16.1.0-previ... 5 1/3/2023
16.1.0-previ... 14 12/26/2022
16.1.0-previ... 49 12/19/2022
16.1.0-previ... 12 12/17/2022
16.1.0-previ... 114 12/11/2022
16.1.0-previ... 12 12/4/2022
16.1.0-previ... 35 11/26/2022
16.1.0-previ... 10 11/24/2022
16.0.1-previ... 30 11/11/2022
16.0.0 826,568 9/9/2022
16.0.0-previ... 29 8/21/2022
16.0.0-previ... 23 8/13/2022
16.0.0-previ... 14 8/13/2022
16.0.0-previ... 25 8/1/2022
16.0.0-previ... 80 6/14/2022
16.0.0-previ... 24 6/8/2022
16.0.0-previ... 17 6/6/2022
16.0.0-previ... 14 6/6/2022
16.0.0-previ... 88 4/26/2022
16.0.0-previ... 44 3/28/2022
16.0.0-previ... 65 2/12/2022
15.2.0 2,683,542 9/1/2021
15.2.0-previ... 15 9/1/2021
15.2.0-previ... 44 7/23/2021
15.2.0-previ... 75 6/6/2021
15.2.0-previ... 65 4/18/2021
15.2.0-previ... 85 3/12/2021
15.1.1 1,379,070 2/12/2021
15.1.1-previ... 17 2/12/2021
15.1.0 62,272 2/2/2021
15.1.0-previ... 24 2/1/2021
15.1.0-previ... 19 1/31/2021
15.0.2-previ... 18 1/30/2021
15.0.2-previ... 24 1/24/2021
15.0.2-previ... 62 1/21/2021
15.0.2-previ... 61 1/12/2021
15.0.1 143,026 1/9/2021
15.0.1-previ... 58 1/9/2021
15.0.1-previ... 63 1/6/2021
15.0.1-previ... 59 1/6/2021
15.0.1-previ... 68 12/27/2020
15.0.1-previ... 59 12/26/2020
15.0.1-previ... 62 12/23/2020
15.0.1-previ... 70 12/14/2020
15.0.1-previ... 61 12/13/2020
15.0.1-previ... 59 12/12/2020
15.0.1-previ... 60 12/10/2020
15.0.0 213,983 12/6/2020
15.0.0-previ... 60 12/6/2020
15.0.0-previ... 65 11/25/2020
15.0.0-previ... 57 11/22/2020
15.0.0-previ... 61 11/21/2020
14.3.0-previ... 98 10/5/2020
14.3.0-previ... 54 10/3/2020
14.3.0-previ... 60 10/2/2020
14.2.2-previ... 104 8/19/2020
14.2.2-previ... 60 8/16/2020
14.2.1 639,631 8/14/2020
14.2.1-previ... 59 8/13/2020
14.2.1-previ... 60 8/11/2020
14.2.1-previ... 56 8/11/2020
14.2.1-previ... 71 7/31/2020
14.2.1-previ... 59 7/28/2020
14.2.0 72,555 7/23/2020
14.2.0-previ... 62 7/23/2020
14.2.0-previ... 64 7/19/2020
14.2.0-previ... 73 7/13/2020
14.2.0-previ... 64 7/10/2020
14.2.0-previ... 61 7/9/2020
14.1.1-previ... 63 7/9/2020
14.1.0 215,481 7/6/2020
14.1.0-previ... 366 7/5/2020
14.1.0-previ... 60 7/4/2020
14.1.0-previ... 61 7/4/2020
14.1.0-previ... 63 7/3/2020
14.1.0-previ... 65 7/1/2020
14.0.1-previ... 71 6/28/2020
14.0.1-previ... 60 6/26/2020
14.0.0 10,834 6/12/2020
14.0.0-previ... 61 6/12/2020
14.0.0-previ... 67 6/11/2020
14.0.0-previ... 69 6/10/2020
14.0.0-previ... 68 6/10/2020
14.0.0-previ... 102 5/28/2020
14.0.0-previ... 77 5/25/2020
14.0.0-previ... 67 5/25/2020
14.0.0-previ... 79 5/19/2020
14.0.0-previ... 75 5/19/2020
14.0.0-previ... 81 5/17/2020
14.0.0-previ... 70 5/17/2020
14.0.0-previ... 68 5/16/2020
14.0.0-previ... 69 5/14/2020
14.0.0-previ... 71 5/13/2020
14.0.0-previ... 79 5/12/2020
14.0.0-previ... 69 5/12/2020
14.0.0-previ... 69 5/12/2020
14.0.0-previ... 82 5/8/2020
14.0.0-previ... 68 5/6/2020
14.0.0-previ... 72 5/5/2020
14.0.0-previ... 70 5/4/2020
14.0.0-previ... 69 5/3/2020
14.0.0-previ... 68 5/3/2020
14.0.0-previ... 83 4/27/2020
14.0.0-previ... 78 4/26/2020
13.5.0 28,255 4/12/2020
13.5.0-previ... 75 4/11/2020
13.5.0-previ... 77 4/11/2020
13.4.1-previ... 104 3/31/2020
13.4.0 122,342 3/18/2020
13.4.0-previ... 70 3/18/2020
13.3.1-previ... 116 1/18/2020
13.3.0 480,195 1/17/2020
13.3.0-previ... 73 1/17/2020
13.3.0-previ... 78 1/12/2020
13.3.0-previ... 72 1/8/2020
13.3.0-previ... 75 1/7/2020
13.3.0-previ... 72 1/3/2020
13.3.0-previ... 73 1/2/2020
13.3.0-previ... 74 1/2/2020
13.2.0.0 860,514 9/19/2019
13.1.0.0 34,989 8/8/2019
13.0.0.0 26,018 6/26/2019
12.5.0.0 17,333 5/15/2019
12.4.0.0 21,698 4/3/2019
12.3.0.0 40,221 2/20/2019
12.2.0.0 8,925 1/10/2019
12.1.0.0 23,219 10/25/2018
12.0.0.0 21,421 9/5/2018
11.4.0.0 16,150 7/25/2018
11.3.0.0 7,375 6/13/2018
11.2.0.0 5,019 5/2/2018
11.1.0.0 6,197 3/22/2018
11.0.0.0 (current version) 12,833 2/8/2018
10.0.0.0 3,648 12/14/2017
Show less