SqlServerDsc

17.2.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 Assert-SqlDscLogin Complete-SqlDscFailoverCluster Complete-SqlDscImage Connect-SqlDscDatabaseEngine ConvertFrom-SqlDscDatabasePermission ConvertFrom-SqlDscServerPermission ConvertTo-SqlDscDatabasePermission ConvertTo-SqlDscEditionName ConvertTo-SqlDscServerPermission Disable-SqlDscAudit Disable-SqlDscLogin Disconnect-SqlDscDatabaseEngine Enable-SqlDscAudit Enable-SqlDscLogin Get-SqlDscAgentAlert Get-SqlDscAudit Get-SqlDscConfigurationOption Get-SqlDscDatabasePermission Get-SqlDscInstalledInstance Get-SqlDscLogin Get-SqlDscManagedComputer Get-SqlDscManagedComputerService Get-SqlDscPreferredModule Get-SqlDscRole Get-SqlDscRSSetupConfiguration Get-SqlDscServerPermission Get-SqlDscStartupParameter Get-SqlDscTraceFlag Import-SqlDscPreferredModule Initialize-SqlDscRebuildDatabase Install-SqlDscBIReportServer Install-SqlDscReportingService Install-SqlDscServer Invoke-SqlDscQuery New-SqlDscAgentAlert New-SqlDscAudit New-SqlDscLogin New-SqlDscRole Remove-SqlDscAgentAlert Remove-SqlDscAudit Remove-SqlDscLogin Remove-SqlDscNode Remove-SqlDscRole Remove-SqlDscTraceFlag Repair-SqlDscBIReportServer Repair-SqlDscReportingService Repair-SqlDscServer Save-SqlDscSqlServerMediaFile Set-SqlDscAgentAlert Set-SqlDscAudit Set-SqlDscDatabasePermission Set-SqlDscServerPermission Set-SqlDscStartupParameter Set-SqlDscTraceFlag Test-SqlDscAgentAlert Test-SqlDscIsDatabasePrincipal Test-SqlDscIsLogin Test-SqlDscIsLoginEnabled Test-SqlDscIsRole Test-SqlDscIsSupportedFeature Test-SqlDscRSInstalled Uninstall-SqlDscBIReportServer Uninstall-SqlDscReportingService Uninstall-SqlDscServer

DSCResources

SqlAudit SqlDatabasePermission SqlPermission SqlRSSetup 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 SqlScript SqlScriptQuery SqlSecureConnection SqlServiceAccount SqlSetup SqlTraceFlag SqlWaitForAG SqlWindowsFirewall

Dependencies

This module has no dependencies.

Release Notes

## [17.2.0-preview0005] - 2025-08-25

### Fixed

- Make sure tests forcibly imports the module being tested to avoid AI failing
 when testing changes.
- Fixed Azure DevOps pipeline conditions that were preventing DSC resource
 integration tests from running when they should by removing incorrect quotes
 around boolean values.

### Added

- Added setup workflow for GitHub Copilot.
 - Switch the workflow to use Linux.
 - Attempt to unshallow the Copilot branch
 - Improved AI instructions.
 - Enhanced workflow with proper environment variable configuration and DSCv3 verification.
 - Fixed environment variable persistence by using $GITHUB_ENV instead of
   job-level env declaration.
- `Assert-SqlDscLogin`
 - Added new public command to validate that a specified SQL Server principal
   is a login.
- `Enable-SqlDscLogin`
 - Added new public command to enable a SQL Server login.
- `Disable-SqlDscLogin`
 - Added new public command to disable a SQL Server login.
- `Test-SqlDscIsLoginEnabled`
 - Added new public command to test whether a SQL Server login is enabled.
   Throws a terminating error if the specified principal does not exist as a login.
 - Supports pipeline input and provides detailed error messages with localization.
 - Uses `Test-SqlDscIsLogin` command for login validation following module patterns.
- Added `Get-SqlDscLogin`, `Get-SqlDscRole`, `New-SqlDscLogin`, `New-SqlDscRole`,
 `Remove-SqlDscRole`, and `Remove-SqlDscLogin` commands for retrieving and managing
  SQL Server logins and roles with support for refresh, pipeline input, and ShouldProcess.
- Added `Get-SqlDscAgentAlert`, `New-SqlDscAgentAlert`,
 `Set-SqlDscAgentAlert`, `Remove-SqlDscAgentAlert`, and `Test-SqlDscAgentAlert`
 to manage SQL Agent alerts on a Database Engine instance.

### Changed

- Refactored GitHub Copilot workflow setup to be module-agnostic via MODULE_NAME
 environment variable, includes full-history detection, uses idempotent .NET
 tool install, and adds Linux dependency handling ([issue #2127](https://github.com/dsccommunity/SqlServerDsc/issues/2127)).
- Module now outputs a verbose message instead of a warning when the SMO
 dependency module is missing during import to work around a DSC v3 issue.
- VS Code tasks configuration was improved to support AI.
- `Prerequisites` tests
 - Added creation of `SqlIntegrationTest` local Windows user for integration testing.
- `tests/Integration/Commands/README.md`
 - Added documentation for `SqlIntegrationTest` user and
   `IntegrationTestSqlLogin` login.
 - Added run order information for `New-SqlDscLogin` integration test.
- `azure-pipelines.yml`
 - Remove `windows-2019` images fixes [#2106](https://github.com/dsccommunity/SqlServerDsc/issues/2106).
 - Move individual tasks to `windows-latest`.
 - Added integration tests for `Assert-SqlDscLogin` command in Group 2.
 - Added conditional logic to skip DSC resource integration tests when
   changes don't affect DSC resources, improving CI/CD performance for
   non-DSC changes.
- `SqlServerDsc.psd1`
 - Set `CmdletsToExport` to `*` in module manifest to fix issue [#2109](https://github.com/dsccommunity/SqlServerDsc/issues/2109).
- Added optimization for DSC resource integration tests
 - Created `.build/Test-ShouldRunDscResourceIntegrationTests.ps1` to analyze
   git changes and decide when DSC resource integration tests are needed.
 - DSC resource integration test stages now run only when changes affect DSC
   resources, public commands used by resources, or related components.
 - Unit tests, QA tests, and command integration tests continue to run for
   all changes.
- Bump actions/checkout task to v5.
- `.build/Test-ShouldRunDscResourceIntegrationTests.ps1`
 - Improved performance by adding an early optimization to check for changes
   under the configured SourcePath before expensive analysis.
 - Moved public command discovery to only run when source changes are detected.
- `.build/README.md`
 - Added flow diagram showing decision process for DSC resource integration tests.
 - Improved documentation with optimized analysis workflow description.
- DSC community style guidelines
 - Added requirement to follow guidelines over existing code patterns.
- Improved markdown, pester, powershell, and changelog instructions.
 - Fixed `Ignore` that seems in edge-cases fail.
 - Improved markdown and changelog instructions.

FileList

Version History

Version Downloads Last updated
17.2.0-previ... (current version) 6 8/25/2025
17.2.0-previ... 5 8/22/2025
17.2.0-previ... 3 8/19/2025
17.2.0-previ... 11 8/9/2025
17.2.0-previ... 12 8/3/2025
17.1.0 436,574 5/22/2025
17.1.0-previ... 25 5/2/2025
17.1.0-previ... 4 5/1/2025
17.1.0-previ... 35 4/7/2025
17.1.0-previ... 5 4/6/2025
17.1.0-previ... 3 4/4/2025
17.1.0-previ... 42 3/24/2025
17.1.0-previ... 11 3/19/2025
17.1.0-previ... 10 3/13/2025
17.1.0-previ... 6 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... 105 10/29/2024
17.0.1-previ... 6 10/26/2024
17.0.1-previ... 14 10/7/2024
17.0.0 1,928,148 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 92,776 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,853 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,760 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,693 5/6/2023
16.3.1-previ... 5 5/6/2023
16.3.1-previ... 9 5/4/2023
16.3.0 42,383 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,313 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,763 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 828,283 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,685,614 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,433,404 2/12/2021
15.1.1-previ... 18 2/12/2021
15.1.0 62,629 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... 64 1/21/2021
15.0.2-previ... 63 1/12/2021
15.0.1 143,079 1/9/2021
15.0.1-previ... 60 1/9/2021
15.0.1-previ... 65 1/6/2021
15.0.1-previ... 61 1/6/2021
15.0.1-previ... 70 12/27/2020
15.0.1-previ... 62 12/26/2020
15.0.1-previ... 64 12/23/2020
15.0.1-previ... 72 12/14/2020
15.0.1-previ... 63 12/13/2020
15.0.1-previ... 61 12/12/2020
15.0.1-previ... 62 12/10/2020
15.0.0 214,890 12/6/2020
15.0.0-previ... 62 12/6/2020
15.0.0-previ... 67 11/25/2020
15.0.0-previ... 59 11/22/2020
15.0.0-previ... 63 11/21/2020
14.3.0-previ... 100 10/5/2020
14.3.0-previ... 56 10/3/2020
14.3.0-previ... 62 10/2/2020
14.2.2-previ... 106 8/19/2020
14.2.2-previ... 62 8/16/2020
14.2.1 648,298 8/14/2020
14.2.1-previ... 61 8/13/2020
14.2.1-previ... 62 8/11/2020
14.2.1-previ... 58 8/11/2020
14.2.1-previ... 73 7/31/2020
14.2.1-previ... 61 7/28/2020
14.2.0 72,788 7/23/2020
14.2.0-previ... 64 7/23/2020
14.2.0-previ... 66 7/19/2020
14.2.0-previ... 75 7/13/2020
14.2.0-previ... 66 7/10/2020
14.2.0-previ... 63 7/9/2020
14.1.1-previ... 65 7/9/2020
14.1.0 221,822 7/6/2020
14.1.0-previ... 370 7/5/2020
14.1.0-previ... 62 7/4/2020
14.1.0-previ... 63 7/4/2020
14.1.0-previ... 65 7/3/2020
14.1.0-previ... 67 7/1/2020
14.0.1-previ... 73 6/28/2020
14.0.1-previ... 62 6/26/2020
14.0.0 10,849 6/12/2020
14.0.0-previ... 63 6/12/2020
14.0.0-previ... 69 6/11/2020
14.0.0-previ... 71 6/10/2020
14.0.0-previ... 70 6/10/2020
14.0.0-previ... 104 5/28/2020
14.0.0-previ... 79 5/25/2020
14.0.0-previ... 69 5/25/2020
14.0.0-previ... 81 5/19/2020
14.0.0-previ... 77 5/19/2020
14.0.0-previ... 83 5/17/2020
14.0.0-previ... 72 5/17/2020
14.0.0-previ... 70 5/16/2020
14.0.0-previ... 71 5/14/2020
14.0.0-previ... 73 5/13/2020
14.0.0-previ... 81 5/12/2020
14.0.0-previ... 71 5/12/2020
14.0.0-previ... 71 5/12/2020
14.0.0-previ... 84 5/8/2020
14.0.0-previ... 70 5/6/2020
14.0.0-previ... 74 5/5/2020
14.0.0-previ... 72 5/4/2020
14.0.0-previ... 71 5/3/2020
14.0.0-previ... 70 5/3/2020
14.0.0-previ... 85 4/27/2020
14.0.0-previ... 80 4/26/2020
13.5.0 28,451 4/12/2020
13.5.0-previ... 77 4/11/2020
13.5.0-previ... 79 4/11/2020
13.4.1-previ... 106 3/31/2020
13.4.0 122,351 3/18/2020
13.4.0-previ... 72 3/18/2020
13.3.1-previ... 118 1/18/2020
13.3.0 481,146 1/17/2020
13.3.0-previ... 75 1/17/2020
13.3.0-previ... 80 1/12/2020
13.3.0-previ... 74 1/8/2020
13.3.0-previ... 77 1/7/2020
13.3.0-previ... 74 1/3/2020
13.3.0-previ... 75 1/2/2020
13.3.0-previ... 76 1/2/2020
13.2.0.0 862,913 9/19/2019
13.1.0.0 35,040 8/8/2019
13.0.0.0 26,092 6/26/2019
12.5.0.0 17,594 5/15/2019
12.4.0.0 21,794 4/3/2019
12.3.0.0 40,236 2/20/2019
12.2.0.0 9,110 1/10/2019
12.1.0.0 23,353 10/25/2018
12.0.0.0 21,448 9/5/2018
11.4.0.0 16,161 7/25/2018
11.3.0.0 7,392 6/13/2018
11.2.0.0 5,471 5/2/2018
11.1.0.0 6,258 3/22/2018
11.0.0.0 13,550 2/8/2018
10.0.0.0 3,652 12/14/2017
Show more