v17.6.0-preview0003

[v17.6.0-preview0003]

Fixed

• SqlScript
  • Fixed logic in Get-TargetResource and Set-TargetResource to throw an error
    when the SQL script file is missing, instead of incorrectly reporting success
    or using a null variable.
  • Fixed Test-TargetResource to return $false (instead of throwing) when
    the SQL script file is missing, enabling DependsOn scenarios where the file
    is created at runtime.

Changed

• SqlScript
  • Added integration test configuration that creates script files and executes
    the resource in a single configuration using DependsOn.
• SqlLogin
  • Added parameter Sid to allow setting the sid of the new login. (issue #1470)

v17.6.0-preview0002

[v17.6.0-preview0002]

Fixed

• SqlScript
  • Fixed logic in Get-TargetResource and Set-TargetResource to throw an error
    when the SQL script file is missing, instead of incorrectly reporting success
    or using a null variable.
  • Fixed Test-TargetResource to return $false (instead of throwing) when
    the SQL script file is missing, enabling DependsOn scenarios where the file
    is created at runtime.

Changed

• SqlScript
  • Added integration test configuration that creates script files and executes
    the resource in a single configuration using DependsOn.

v17.6.0-preview0001

[v17.6.0-preview0001]

Fixed

• SqlScript
  • Fixed logic in Get-TargetResource and Set-TargetResource to throw an error
    when the SQL script file is missing, instead of incorrectly reporting success
    or using a null variable.
  • Fixed Test-TargetResource to return $false (instead of throwing) when
    the SQL script file is missing, enabling DependsOn scenarios where the file
    is created at runtime.

Changed

• SqlScript
  • Added integration test configuration that creates script files and executes
    the resource in a single configuration using DependsOn.

v17.5.1

[v17.5.1]

Added

• SqlServerDsc
  • Added private functions ConvertTo-SqlString and ConvertTo-EscapedQueryString
    to safely escape T-SQL string literals and query arguments
    (issue #2442).
• DSC_SqlReplication
  • Updated Install-RemoteDistributor to escape T-SQL arguments for SQL Server
    2025 to prevent SQL injection and ensure proper password redaction
    (issue #2442).

Changed

• SqlServerDsc
  • Updated Pester test guidance in AI instructions in community style guidelines.
  • Added SChannelDsc as a required module for integration tests and enabled the
    prerequisites tests Ensure TLS 1.2 is enabled (issue #2441).

v17.5.1-preview0001

[v17.5.1-preview0001]

Added

• SqlServerDsc
  • Added private functions ConvertTo-SqlString and ConvertTo-EscapedQueryString
    to safely escape T-SQL string literals and query arguments
    (issue #2442).
• DSC_SqlReplication
  • Updated Install-RemoteDistributor to escape T-SQL arguments for SQL Server
    2025 to prevent SQL injection and ensure proper password redaction
    (issue #2442).

Changed

• SqlServerDsc
  • Updated Pester test guidance in AI instructions in community style guidelines.
  • Added SChannelDsc as a required module for integration tests and enabled the
    prerequisites tests Ensure TLS 1.2 is enabled (issue #2441).

v17.5.0

[v17.5.0]

Changed

• SqlServerDsc.Common
  • Moved functions into individual files and use ModuleBuilder to assemble.
• SqlServerDsc
  • Refactor integration tests for SQL Server Reporting Services and Power BI
    Report Server (issue #2431).
  • Connect-Sql create connection and server objects as per documentation.
  • Invoke-SqlDscQuery remove disconnect as there is not an explicit connect.
  • Add SQL Server 2025 to integration tests (issue #2427).

Fixed

• SqlServerDsc
  • Fixed PowerShell Gallery badge URL in README.md to correctly show
    prereleases (issue #2437).

v17.5.0-preview0001

[v17.5.0-preview0001]

Changed

• SqlServerDsc.Common
  • Moved functions into individual files and use ModuleBuilder to assemble.
• SqlServerDsc
  • Refactor integration tests for SQL Server Reporting Services and Power BI
    Report Server (issue #2431).
  • Connect-Sql create connection and server objects as per documentation.
  • Invoke-SqlDscQuery remove disconnect as there is not an explicit connect.
  • Add SQL Server 2025 to integration tests (issue #2427).

Fixed

• SqlServerDsc
  • Fixed PowerShell Gallery badge URL in README.md to correctly show
    prereleases (issue #2437).

v17.4.1-preview0002

[v17.4.1-preview0002]

Changed

• SqlServerDsc.Common

  • Moved functions into individual files and use ModuleBuilder to assemble.

• SqlServerDsc

  • Refactor integration tests for SQL Server Reporting Services and Power BI
    Report Server (issue #2431).
  • Connect-Sql create connection and server objects as per documentation.
  • Invoke-SqlDscQuery remove disconnect as there is not an explicit connect.

v17.4.1-preview0001

[v17.4.1-preview0001]

Changed

• SqlServerDsc.Common

  • Moved functions into individual files and use ModuleBuilder to assemble.

• SqlServerDsc

  • Refactor integration tests for SQL Server Reporting Services and Power BI
    Report Server (issue #2431).

v17.4.0

[v17.4.0]

Added

• SqlRSSetup
  • Added DSCv3 integration tests to verify compatibility with DSCv3
    (issue #2403).
• Added public command Set-SqlDscRSDatabaseTimeout to set the database logon
  timeout and/or query timeout for SQL Server Reporting Services or Power BI
  Report Server. Supports setting LogonTimeout, QueryTimeout, or both via
  parameter sets. Uses the SetDatabaseLogonTimeout and SetDatabaseQueryTimeout
  WMI methods.
• Added public commands Start-SqlDscRSWindowsService, Stop-SqlDscRSWindowsService,
  Start-SqlDscRSWebService, and Stop-SqlDscRSWebService to manage Reporting
  Services Windows and web services using the SetServiceState WMI method.
• SqlServerDsc
  • Added class ReportServerUri to represent URLs returned by the
    GetReportServerUrls CIM method on MSReportServer_Instance.
• Added public command Get-SqlDscRSUrl to get the Report Server URLs for
  SQL Server Reporting Services or Power BI Report Server. This command
  invokes the GetReportServerUrls CIM method on MSReportServer_Instance
  and returns an array of ReportServerUri objects containing the instance
  name, application name, and URL for each configured URL.
• Added public command Get-SqlDscRSConfigFile to get the RsReportServer.config
  configuration file for SQL Server Reporting Services (SSRS) or Power BI
  Report Server (PBIRS) as an XML document object. Supports three parameter
  sets: ByInstanceName (looks up path via registry), ByConfiguration
  (accepts pipeline input from Get-SqlDscRSSetupConfiguration), and ByPath
  (reads from a direct file path). The returned XML object supports standard
  XML navigation and XPath queries for accessing configuration settings.
• Added public command Get-SqlDscRSLogPath to get the log file folder path
  for SQL Server Reporting Services or Power BI Report Server. Returns the
  ErrorDumpDirectory from the instance's setup configuration, which can be
  used with Get-ChildItem and Get-Content to access service logs, portal
  logs, and memory dumps.
• Added public command Get-SqlDscRSExecutionLog to query execution log entries
  from the ExecutionLog3 view in the report server database. Supports filtering
  by date range, user name, report path, and maximum rows. Includes connection
  parameters Credential, LoginType, Encrypt, and StatementTimeout.
• Added public command Test-SqlDscRSAccessible to verify that SQL Server
  Reporting Services or Power BI Report Server web sites are accessible.
  Supports both CIM configuration input (with dynamic -Site parameter) and
  explicit URIs. Includes retry logic and optional detailed output with HTTP
  status codes.
• Added post-initialization integration tests for RS commands
  (Post.Initialization.RS.Integration.Tests.ps1) to verify that SSRS and
  PBIRS sites are fully accessible after Initialize-SqlDscRS runs.
• Added public command Request-SqlDscRSDatabaseScript to generate T-SQL scripts
  for creating report server databases. Wraps the GenerateDatabaseCreationScript
  CIM method and supports configuring database name, language (LCID), and
  SharePoint mode (issue #2017).
• Added public command Request-SqlDscRSDatabaseRightsScript to generate T-SQL
  scripts for granting permissions on report server databases. Wraps the
  GenerateDatabaseRightsScript CIM method and supports configuring database
  name, user name, remote connections, and Windows/SQL authentication types
  (issue #2019).
• Added public command Set-SqlDscRSDatabaseConnection to set
  the report server database connection for SQL Server Reporting Services or
  Power BI Report Server. Wraps the SetDatabaseConnection CIM method and
  supports Windows, SQL Server, and Service Account authentication types
  (issue #2021).
• Added public command Set-SqlDscRSVirtualDirectory to set the virtual directory
  for Reporting Services applications. Wraps the SetVirtualDirectory CIM method
  and supports ReportServerWebService, ReportServerWebApp, and ReportManager
  applications (issue #2015).
• Added public commands Get-SqlDscRSUrlReservation, Add-SqlDscRSUrlReservation,
  Remove-SqlDscRSUrlReservation, and Set-SqlDscRSUrlReservation to manage
  URL reservations for SQL Server Reporting Services or Power BI Report Server.
  These commands wrap the ListReservedUrls, ReserveUrl, and RemoveURL CIM
  methods respectively. The Set-SqlDscRSUrlReservation command provides a
  declarative approach to set URL reservations to an exact list, removing any
  existing reservations not in the specified list
  (issue #2016)
  (issue #2024).
• Added public command Get-SqlDscRSConfiguration to retrieve the
  MSReportServer_ConfigurationSetting CIM instance for SQL Server Reporting
  Services or Power BI Report Server. Supports auto-detection of the Reporting
  Services version or explicit version specification. The returned CIM instance
  can be piped to Enable-SqlDscRsSecureConnection or Disable-SqlDscRsSecureConnection
  (issue #2022).
• Added public command Get-SqlDscRSWebPortalApplicationName to get the
  Reporting Services web portal application name based on the SQL Server
  version. Returns 'ReportServerWebApp' for SQL Server 2016 (version 13) and
  later, or 'ReportManager' for earlier versions. Accepts the setup configuration
  object from Get-SqlDscRSSetupConfiguration via pipeline.
• Added public command Enable-SqlDscRsSecureConnection to enable secure
  connection for SQL Server Reporting Services or Power BI Report Server by
  setting the secure connection level to 1. Accepts the configuration CIM
  instance from pipeline, supports -WhatIf/-Confirm, and -PassThru to
  return the configuration object
  (issue #2022).
• Added public command Disable-SqlDscRsSecureConnection to disable secure
  connection for SQL Server Reporting Services or Power BI Report Server by
  setting the secure connection level to 0. Accepts the configuration CIM
  instance from pipeline, supports -WhatIf/-Confirm, and -PassThru to
  return the configuration object
  (issue #2023).
• Added private function Invoke-RsCimMethod to invoke CIM methods on Reporting
  Services configuration instances with consistent error handling. This function
  is used by Enable-SqlDscRsSecureConnection, Disable-SqlDscRsSecureConnection,
  and the SqlRS resource.
  • Added parameters RetryCount, RetryDelaySeconds, and SkipRetry to provide
    configurable retry behavior for transient CIM method failures. By default,
    retries up to 3 times with 30-second delays. Handles both HRESULT failures
    and exceptions from Invoke-CimMethod. Collects unique errors across retry
    attempts with attempt number prefixes for comprehensive error reporting.
• Invoke-ReportServerSetupAction
  • Now uses Format-Path with -ExpandEnvironmentVariable to expand environment
    variables in all path parameters (MediaPath, LogPath, InstallFolder)
    (issue #2085).
• Added public command Get-SqlDscServerProtocolTcpIp to retrieve TCP/IP address
  group information for SQL Server instances. Returns ServerIPAddress objects
  containing port configuration including TcpPort, TcpDynamicPorts, Enabled,
  and Active properties. Supports filtering by specific IP address group name
  and accepts pipeline input from Get-SqlDscServerProtocol.
• SqlResourceBase
  • Added Protocol property to specify the network protocol (tcp, np, lpc)
    when connecting to SQL Server instances
    (issue #2041).
  • Added Port property to specify the TCP port number when connecting to SQL
    Server instances
    (issue #2041).
• Connect-SqlDscDatabaseEngine
  • Added Protocol parameter to specify the network protocol when connecting.
  • Added Port parameter to specify the TCP port number when connecting.
    Connection strings now support the format [protocol:]hostname[\instance][,port].
• SqlDatabase
  • Added new class-based resource to create, modify, or remove databases on a
    SQL Server instance. Supports a comprehensive set of database properties
    that can be configured with Set-SqlDscDatabaseProperty
    (issue #2174).
  • Added DSCv3 integration tests to verify compatibility with DSCv3
    (issue #2403).
• Install-SqlDscServer
  • Added parameter AllowDqRemoval to the Upgrade parameter set
    (issue #2155).
• Test-SqlDscIsSupportedFeature
  • Added DQ, DQC, and MDS features as discontinued starting with SQL Server 2025
    (17.x) and later versions (issue #2380).
• Added public command Get-SqlDscRSPackage to retrieve package information for
  SQL Server Reporting Services or Power BI Report Server. Supports getting version
  information from an executable file
  (issue #2082).
• Added public command Get-SqlDscBackupFileList to read the list of database
  files contained in a SQL Server b...