SqlServerDsc

17.1.0-preview0005

This module contains commands and DSC resources for deployment and configuration of Microsoft SQL Server, SQL Server Reporting Services and Power BI Report Server.

Minimum PowerShell version

5.0

This is a prerelease version of SqlServerDsc.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name SqlServerDsc -AllowPrerelease

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

Install-PSResource -Name SqlServerDsc -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 SqlServer PowerBI ReportingServices ReportServer

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-SqlDscConfigurationOption Get-SqlDscDatabasePermission Get-SqlDscInstalledInstance Get-SqlDscManagedComputer Get-SqlDscManagedComputerService Get-SqlDscPreferredModule Get-SqlDscRSSetupConfiguration Get-SqlDscServerPermission Get-SqlDscStartupParameter Get-SqlDscTraceFlag Import-SqlDscPreferredModule Initialize-SqlDscRebuildDatabase Install-SqlDscBIReportServer Install-SqlDscReportingService Install-SqlDscServer Invoke-SqlDscQuery New-SqlDscAudit Remove-SqlDscAudit Remove-SqlDscNode Remove-SqlDscTraceFlag Repair-SqlDscBIReportServer Repair-SqlDscReportingService Repair-SqlDscServer Save-SqlDscSqlServerMediaFile Set-SqlDscAudit Set-SqlDscDatabasePermission Set-SqlDscServerPermission Set-SqlDscStartupParameter Set-SqlDscTraceFlag Test-SqlDscIsDatabasePrincipal Test-SqlDscIsLogin Test-SqlDscIsSupportedFeature Test-SqlDscRSInstalled Uninstall-SqlDscBIReportServer Uninstall-SqlDscReportingService 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

## [17.1.0-preview0005] - 2025-03-13

### Removed

- SqlServerDsc.Common
 - Removed the function `Get-RegistryPropertyValue` in favor of the command
   with the same name in the module _DscResource.Common_.

### Added

- Public commands:
 - `Get-SqlDscInstalledInstance` to retrieve installed SQL instances.
 - `Get-SqlDscRSSetupConfiguration` to retrieve the setup configuration of
   SQL Server Reporting Services or Power BI Report Server ([issue #2072](https://github.com/dsccommunity/SqlServerDsc/issues/2072)).
 - `Install-SqlDscReportingService` to install SQL Server Reporting Services
   ([issue #2010](https://github.com/dsccommunity/SqlServerDsc/issues/2010)).
 - `Install-SqlDscBIReportServer` to install SQL Server BI Report Server.
   ([issue #2010](https://github.com/dsccommunity/SqlServerDsc/issues/2010)).
 - `Repair-SqlDscReportingService` to repair an already installed SQL Server
   Reporting Services ([issue #2064](https://github.com/dsccommunity/SqlServerDsc/issues/2064)).
 - `Repair-SqlDscBIReportServer` to repair an already installed SQL Server
   BI Report Server ([issue #2064](https://github.com/dsccommunity/SqlServerDsc/issues/2064)).
 - `Test-SqlDscRSInstalled` to test whether an instance is installed or not
    ([issue #2078](https://github.com/dsccommunity/SqlServerDsc/issues/2078)).
 - `Uninstall-SqlDscReportingService` to uninstall SQL Server Reporting
   Services ([issue #2065](https://github.com/dsccommunity/SqlServerDsc/issues/2065)).
 - `Uninstall-SqlDscBIReportServer` to uninstall SQL Server BI Report Server
   ([issue #2065](https://github.com/dsccommunity/SqlServerDsc/issues/2065)).
- Private function:
 - `Invoke-ReportServerSetupAction` to run setup actions for Reporting
   Services and Power BI Report Server.
- Added new instructions for GitHub Copilot that might assist when developing
 command and private functions in the module. More instructions should be
 added as needed to help generated code and tests.

### Changed

- SqlServerDsc
 - The examples that was located in the README in the examples folder has
   now been moved to the WikiSource folder. The examples are published to
   the repository Wiki. The README has been updated to link to the new
   location ([issue #2051](https://github.com/dsccommunity/SqlServerDsc/issues/2051)).
 - Integration test stages has been modified to split the testing into
   several different areas. The tests are dependent on this order:
   - Quality_Test_and_Unit_Test
   - Integration_Test_Commands_SqlServer
     - Integration_Test_Commands_ReportingServices
     - Integration_Test_Commands_BIReportServer
   - Integration_Test_Resources_SqlServer
     - Integration_Test_Resources_SqlServer_dbatools
     - Integration_Test_Resources_ReportingServices
       - Integration_Test_Resources_ReportingServices_dbatools
 - Update build script path in integration tests.
 - Fix style formatting in all PowerShell script files.
 - Update module description on GitHub, in the conceptual help, and in
   the module manifest.
- SqlSetup
 - Fixed issue with AddNode where cluster IP information was not being passed to
   setup.exe ([issue #1171](https://github.com/dsccommunity/SqlServerDsc/issues/1171)).

### Fixed

- Fixed workaround for the GitHub Actions to support building module in Windows
 PowerShell.
- SqlServerDsc
 - Fix localization tests.
- `SqlAudit`
 - Fix localization strings in `Assert` method.
- `Save-SqlDscSqlServerMediaFile`
 - Fix localizations strings that used wrong keys.
 - Fix unit tests so they work cross-platform.
- `Install-SqlDscServer` and private function `Invoke-SetupAction`
 - Fix localization string keys naming.
 - Fix unit tests to use correct localization string names.
 - Remove redundant unit tests.
- `SqlConfiguration`
 - Change the alias command to real command name, to pass HQRM tests.
- `SqlDatabaseUser`
 - Change the alias command to real command name, to pass HQRM tests.
- `SqlMaxDop`
 - Change the alias command to real command name, to pass HQRM tests.
- `SqlMemory`
 - Change the alias command to real command name, to pass HQRM tests.
- `SqlReplication`
 - Change the alias command to real command name, to pass HQRM tests.
- `SqlRSSetup`
 - Change the alias command to real command name, to pass HQRM tests.
- `SqlServiceAccount`
 - Change the alias command to real command name, to pass HQRM tests.

FileList

Version History

Version Downloads Last updated
17.1.0-previ... (current version) 3 3/13/2025
17.1.0-previ... 3 3/12/2025
17.1.0-previ... 3 3/11/2025
17.1.0-previ... 27 3/4/2025
17.1.0-previ... 6 3/2/2025
17.0.1-previ... 104 10/29/2024
17.0.1-previ... 6 10/26/2024
17.0.1-previ... 14 10/7/2024
17.0.0 392,448 9/30/2024
17.0.0-previ... 5 9/29/2024
17.0.0-previ... 49 8/13/2024
16.6.1-previ... 118 5/23/2024
16.6.1-previ... 5 5/22/2024
16.6.0 91,732 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 145,531 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,648 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,346 5/6/2023
16.3.1-previ... 5 5/6/2023
16.3.1-previ... 9 5/4/2023
16.3.0 42,289 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... 28 4/18/2023
16.3.0-previ... 5 4/16/2023
16.2.1-previ... 7 4/12/2023
16.2.0 75,192 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,612 2/28/2023
16.1.0-previ... 6 2/28/2023
16.1.0-previ... 9 2/25/2023
16.1.0-previ... 7 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,990 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,994 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,402,458 2/12/2021
15.1.1-previ... 18 2/12/2021
15.1.0 62,537 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,078 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,703 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 643,577 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,744 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,797 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,848 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,427 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,774 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 862,295 9/19/2019
13.1.0.0 35,028 8/8/2019
13.0.0.0 26,085 6/26/2019
12.5.0.0 17,525 5/15/2019
12.4.0.0 21,762 4/3/2019
12.3.0.0 40,232 2/20/2019
12.2.0.0 9,061 1/10/2019
12.1.0.0 23,308 10/25/2018
12.0.0.0 21,443 9/5/2018
11.4.0.0 16,160 7/25/2018
11.3.0.0 7,383 6/13/2018
11.2.0.0 5,250 5/2/2018
11.1.0.0 6,250 3/22/2018
11.0.0.0 13,548 2/8/2018
10.0.0.0 3,650 12/14/2017
Show more