v14.1.0-preview0005

[v14.1.0-preview0005]

Removed

• SqlServerDsc
  • Remove the file .github/CONTRIBUTION.md as it no longer filled any
    purpose as GitHub will find the CONTRIBUTION.md in the root folder
    directly now (issue #1227).

Fixed

• SqlServerDsc
  • Update resource parameter documentation (issue #1568).
    • Remove italic and inline code-block markdown code in documentation.
  • Documentation is now published to the GitHub Wiki.
    • Deploy task was updated with the correct name.
  • Minor changes too schema property descriptions to generate documentation
    correctly.
  • Updated task list in the PULL_REQUEST_TEMPLATE.md.
  • The documentation in CONTRIBUTING.md has been somewhat updated.
  • Update documentation around design pattern for accounts that does not
    use passwords (issue #378)
    and (issue #1230).
  • Updating the Integration Test README.md to better explain what the
    integration tests for SqlSetup, SqlRSSetup, and SqlRS does (issue #1315).
• SqlServerDsc.Common
  • Connect-UncPath
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQL
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQLAnalysis
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
• SqlAGReplica
  • Update documentation with a requirement for SqlServer in certain circumstances
    (issue #1033).
• SqlRSSetup
  • There was a typo in the error message that was thrown when not passing
    either the Edition or ProductKey that could be misleading (issue #1386).
  • Updated the parameter descriptions for the parameters Edition and
    ProductKey that they are mutually exclusive (issue #1386).
• SqlWindowsFirewall
  • Now support to authenticate using both NetBIOS domain and Fully Qualified
    Domain Name (FQDN) (issue #1223).
• SqlDatabaseObjectPermission
  • Since the task that publish Wiki content was updated to correctly handle
    embedded instances the duplicate documentation was removed from the
    resource README.md, and some was added to the schema MOF parameter
    descriptions (issue #1580).
• SqlScript
  • Fixed the URLs in the parameter documentation (issue #1582).
• SqlScriptQuery
  • Fixed the URLs in the parameter documentation (issue #1583).

Added

• SqlScript
  • Added the DisableVariables parameter (issue #1422).
• SqlScriptQuery
  • Added the DisableVariables parameter (issue #1422).

v14.1.0-preview0004

[v14.1.0-preview0004]

Removed

• SqlServerDsc
  • Remove the file .github/CONTRIBUTION.md as it no longer filled any
    purpose as GitHub will find the CONTRIBUTION.md in the root folder
    directly now (issue #1227).

Fixed

• SqlServerDsc
  • Update resource parameter documentation (issue #1568).
    • Remove italic and inline code-block markdown code in documentation.
  • Documentation is now published to the GitHub Wiki.
    • Deploy task was updated with the correct name.
  • Minor changes too schema property descriptions to generate documentation
    correctly.
  • Updated task list in the PULL_REQUEST_TEMPLATE.md.
  • The documentation in CONTRIBUTING.md has been somewhat updated.
  • Update documentation around design pattern for accounts that does not
    use passwords (issue #378)
    and (issue #1230).
  • Updating the Integration Test README.md to better explain what the
    integration tests for SqlSetup, SqlRSSetup, and SqlRS does (issue #1315).
• SqlServerDsc.Common
  • Connect-UncPath
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQL
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQLAnalysis
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
• SqlAGReplica
  • Update documentation with a requirement for SqlServer in certain circumstances
    (issue #1033).
• SqlRSSetup
  • There was a typo in the error message that was thrown when not passing
    either the Edition or ProductKey that could be misleading (issue #1386).
  • Updated the parameter descriptions for the parameters Edition and
    ProductKey that they are mutually exclusive (issue #1386).
• SqlWindowsFirewall
  • Now support to authenticate using both NetBIOS domain and Fully Qualified
    Domain Name (FQDN) (issue #1223).
• SqlDatabaseObjectPermission
  • Since the task that publish Wiki content was updated to correctly handle
    embedded instances the duplicate documentation was removed from the
    resource README.md, and some was added to the schema MOF parameter
    descriptions (issue #1580).

Added

• SqlScript
  • Added the DisableVariables parameter (issue #1422).
• SqlScriptQuery
  • Added the DisableVariables parameter (issue #1422).

v14.1.0-preview0003

[v14.1.0-preview0003]

Removed

• SqlServerDsc
  • Remove the file .github/CONTRIBUTION.md as it no longer filled any
    purpose as GitHub will find the CONTRIBUTION.md in the root folder
    directly now (issue #1227).

Fixed

• SqlServerDsc
  • Update resource parameter documentation (issue #1568).
  • Documentation is now published to the GitHub Wiki.
    • Deploy task was updated with the correct name.
  • Minor changes too schema property descriptions to generate documentation
    correctly.
  • Updated task list in the PULL_REQUEST_TEMPLATE.md.
  • The documentation in CONTRIBUTING.md has been somewhat updated.
  • Update documentation around design pattern for accounts that does not
    use passwords (issue #378)
    and (issue #1230).
  • Updating the Integration Test README.md to better explain what the
    integration tests for SqlSetup, SqlRSSetup, and SqlRS does (issue #1315).
• SqlServerDsc.Common
  • Connect-UncPath
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQL
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQLAnalysis
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
• SqlAGReplica
  • Update documentation with a requirement for SqlServer in certain circumstances
    (issue #1033).
• SqlRSSetup
  • There was a typo in the error message that was thrown when not passing
    either the Edition or ProductKey that could be misleading (issue #1386).
  • Updated the parameter descriptions for the parameters Edition and
    ProductKey that they are mutually exclusive (issue #1386).
• SqlWindowsFirewall
  • Now support to authenticate using both NetBIOS domain and Fully Qualified
    Domain Name (FQDN) (issue #1223).
• SqlDatabaseObjectPermission
  • Since the task that publish Wiki content was updated to correctly handle
    embedded instances the duplicate documentation was removed from the
    resource README.md, and some was added to the schema MOF parameter
    descriptions (issue #1580).

Added

• SqlScript
  • Added the DisableVariables parameter (issue #1422).
• SqlScriptQuery
  • Added the DisableVariables parameter (issue #1422).

v14.1.0-preview0002

[v14.1.0-preview0002]

Removed

• SqlServerDsc
  • Remove the file .github/CONTRIBUTION.md as it no longer filled any
    purpose as GitHub will find the CONTRIBUTION.md in the root folder
    directly now (issue #1227).

Fixed

• SqlServerDsc
  • Update resource parameter documentation (issue #1568).
  • Documentation is now published to the GitHub Wiki.
    • Deploy task was updated with the correct name.
  • Minor changes too schema property descriptions to generate documentation
    correctly.
  • Updated task list in the PULL_REQUEST_TEMPLATE.md.
  • The documentation in CONTRIBUTING.md has been somewhat updated.
  • Update documentation around design pattern for accounts that does not
    use passwords (issue #378)
    and (issue #1230).
  • Updating the Integration Test README.md to better explain what the
    integration tests for SqlSetup, SqlRSSetup, and SqlRS does (issue #1315).
• SqlServerDsc.Common
  • Connect-UncPath
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQL
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQLAnalysis
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
• SqlAGReplica
  • Update documentation with a requirement for SqlServer in certain circumstances
    (issue #1033).
• SqlRSSetup
  • There was a typo in the error message that was thrown when not passing
    either the Edition or ProductKey that could be misleading (issue #1386).
  • Updated the parameter descriptions for the parameters Edition and
    ProductKey that they are mutually exclusive (issue #1386).
• SqlWindowsFirewall
  • Now support to authenticate using both NetBIOS domain and Fully Qualified
    Domain Name (FQDN) (issue #1223).
• SqlDatabaseObjectPermission
  • Since the task that publish Wiki content was updated to correctly handle
    embedded instances the duplicate documentation was removed from the
    resource README.md, and some was added to the schema MOF parameter
    descriptions (issue #1580).

v14.1.0-preview0001

[v14.1.0-preview0001]

Removed

• SqlServerDsc
  • Remove the file .github/CONTRIBUTION.md as it no longer filled any
    purpose as GitHub will find the CONTRIBUTION.md in the root folder
    directly now (issue #1227).

Fixed

• SqlServerDsc
  • Update resource parameter documentation (issue #1568).
  • Documentation is now published to the GitHub Wiki.
    • Deploy task was updated with the correct name.
  • Minor changes too schema property descriptions to generate documentation
    correctly.
  • Updated task list in the PULL_REQUEST_TEMPLATE.md.
  • The documentation in CONTRIBUTING.md has been somewhat updated.
  • Update documentation around design pattern for accounts that does not
    use passwords (issue #378)
    and (issue #1230).
  • Updating the Integration Test README.md to better explain what the
    integration tests for SqlSetup, SqlRSSetup, and SqlRS does (issue #1315).
• SqlServerDsc.Common
  • Connect-UncPath
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQL
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQLAnalysis
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
• SqlAGReplica
  • Update documentation with a requirement for SqlServer in certain circumstances
    (issue #1033).
• SqlRSSetup
  • There was a typo in the error message that was thrown when not passing
    either the Edition or ProductKey that could be misleading (issue #1386).
  • Updated the parameter descriptions for the parameters Edition and
    ProductKey that they are mutually exclusive (issue #1386).
• SqlWindowsFirewall
  • Now support to authenticate using both NetBIOS domain and Fully Qualified
    Domain Name (FQDN) (issue #1223).

v14.0.1-preview0002

[v14.0.1-preview0002]

Fixed

• SqlServerDsc
  • Update resource parameter documentation (issue #1568).
  • Documentation is now published to the GitHub Wiki.
    • Deploy task was updated with the correct name.
• SqlServerDsc.Common
  • Connect-UncPath
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQL
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
  • Connect-SQLAnalysis
    • Now support to authenticate using both NetBIOS domain and Fully Qualified
      Domain Name (FQDN) (issue #1223).
• SqlWindowsFirewall
  • Now support to authenticate using both NetBIOS domain and Fully Qualified
    Domain Name (FQDN) (issue #1223).

v14.0.1-preview0001

[v14.0.1-preview0001]

Fixed

• SqlServerDsc
  • Update resource parameter documentation (issue #1568).
  • Documentation is now published to the GitHub Wiki.
    • Deploy task was updated with the correct name.

v14.0.0

[v14.0.0]

Remove

• SqlServerDsc
  • BREAKING CHANGE: Since the operating system Windows Server 2008 R2 and
    the product SQL Server 2008 R2 has gone end-of-life the DSC resources
    will no longer try to maintain compatibility with them. Moving forward,
    and including this release, there may be code changes that will break
    the resource on Windows Server 2008 R2 or with SQL Server 2008 R2
    (issue #1514).

Deprecated

The documentation, examples, unit test, and integration tests have been
removed for these deprecated resources. These resources will be removed
in a future release.

• SqlDatabaseOwner
  • This resource is now deprecated. The functionality is now covered by
    a property in the resource SqlDatabase (issue #966).
• SqlDatabaseRecoveryModel
  • This resource is now deprecated. The functionality is now covered by
    a property in the resource SqlDatabase (issue #967).
• SqlServerEndpointState
  • This resource is now deprecated. The functionality is covered by a
    property in the resource SqlEndpoint (issue #968).
• SqlServerNetwork
  • This resource is now deprecated. The functionality is now covered by
    the resources SqlProtocol and SqlProtocolTcpIp.

Added

• SqlSetup
  • Added support for major version upgrade (issue #1561).
• SqlServerDsc
  • Added new resource SqlProtocol (issue #1377).
  • Added new resource SqlProtocolTcpIp (issue #1378).
  • Added new resource SqlDatabaseObjectPermission (issue #1119).
  • Fixing a problem with the latest ModuleBuild 1.7.0 that breaks the CI
    pipeline.
  • Prepare repository for auto-documentation by adding README.md to each
    resource folder with the content from the root README.md.
• SqlServerDsc.Common
  • Added function Import-Assembly that can help import an assembly
    into the PowerShell session.
  • Prepared unit tests to support Pester 5 so a minimal conversation
    is only needed later.
  • Updated Import-SQLPSModule to better support unit tests.
• CommonTestHelper
  • Added the functions Get-InvalidOperationRecord and Get-InvalidResultRecord
    that is needed for evaluate localized error message strings for unit tests.
• SqlEndpoint
  • BREAKING CHANGE: A new required property EndpointType was added to
    support different types of endpoints in the future. For now the only
    endpoint type that is supported is the database mirror endpoint type
    (DatabaseMirroring).
  • Added the property State to be able to specify if the endpoint should
    be running, stopped, or disabled. This property was moved from the now
    deprecated DSC resource SqlServerEndpointState.
• SqlSetup
  • A read only property IsClustered was added that can be used to determine
    if the instance is clustered.
  • Added the properties NpEnabled and TcpEnabled (issue #1161).
  • Added the property UseEnglish (issue #1473).
• SqlReplication
  • Add integration tests (issue #755.
• SqlDatabase
  • The property OwnerName was added.
• SqlDatabasePermission
  • Now possible to change permissions for database user-defined roles
    (e.g. public) and database application roles (issue #1498.
• SqlServerDsc.Common
  • The helper function Restart-SqlService was improved to handle Failover
    Clusters better. Now the SQL Server service will only be taken offline
    and back online again if the service is online to begin with.
  • The helper function Restart-SqlServer learned the new parameter
    OwnerNode. The parameter OwnerNode takes an array of Cluster node
    names. Using this parameter the cluster group will only be taken
    offline and back online if the cluster group owner is one specified
    in this parameter.
  • The helper function Compare-ResourcePropertyState was improved to
    handle embedded instances by adding a parameter CimInstanceKeyProperties
    that can be used to identify the unique parameter for each embedded
    instance in a collection.
  • The helper function Test-DscPropertyState was improved to evaluate
    the properties in a single CIM instance or a collection of CIM instances
    by recursively call itself.
  • When the helper function Test-DscPropertyState evaluated an array
    the verbose messages was not very descriptive. Instead of outputting
    the side indicator from the compare it now outputs a descriptive
    message.

Changed

• SqlServerDsc
  • BREAKING CHANGE: Some DSC resources have been renamed (issue #1540).
    • SqlServerConfiguration was renamed to SqlConfiguration.
    • SqlServerDatabaseMail was renamed to SqlDatabaseMail.
    • SqlServerEndpoint was renamed to SqlEndpoint.
    • SqlServerEndpointPermission was renamed to SqlEndpointPermission.
    • SqlServerLogin was renamed to SqlLogin.
    • SqlServerMaxDop was renamed to SqlMaxDop.
    • SqlServerMemory was renamed to SqlMemory.
    • SqlServerPermission was renamed to SqlPermission.
    • SqlServerProtocol was renamed to SqlProtocol.
    • SqlServerProtocolTcpIp was renamed to SqlProtocolTcpIp.
    • SqlServerReplication was renamed to SqlReplication.
    • SqlServerRole was renamed to SqlRole.
    • SqlServerSecureConnection was renamed to SqlSecureConnection.
  • Changed all resource prefixes from MSFT_ to DSC_ (issue #1496).
    Deprecated resource has not changed prefix.
  • All resources are now using the common module DscResource.Common.
  • When a PR is labelled with 'ready for merge' it is no longer being
    marked as stale if the PR is not merged for 30 days (for example it is
    dependent on something else) (issue #1504).
  • Updated the CI pipeline to use latest version of the module ModuleBuilder.
  • Changed to use the property NuGetVersionV2 from GitVersion in the
    CI pipeline.
  • The unit tests now run on PowerShell 7 to optimize the total run time.
• SqlServerDsc.Common
  • The helper function Invoke-InstallationMediaCopy was changed to
    handle a breaking change in PowerShell 7 (issue #1530).
  • Removed the local helper function Set-PSModulePath as it was
    implemented in the module DscResource.Common.
• CommonTestHelper
  • The test helper function New-SQLSelfSignedCertificate was changed
    to install the dependent module PSPKI through RequiredModules.psd1.
• SqlAlwaysOnService
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • Normalize parameter descriptive text for default values.
• SqlDatabase
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • BREAKING CHANGE: The non-mandatory parameters was removed from the
    function Get-TargetResource since they were not needed.
  • BREAKING CHANGE: The properties CompatibilityLevel and Collation
    are now only enforced if the are specified in the configuration.
  • Normalize parameter descriptive text for default values.
• SqlDatabaseDefaultLocation
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • Normalize parameter descriptive text for default values.
• SqlDatabaseOwner
  • BREAKING CHANGE: Database changed to DatabaseName for consistency with
    other modules (issue #1484).
• SqlDatabasePermission
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • Normalize parameter descriptive text for default values.
  • BREAKING CHANGE: Database changed to DatabaseName for consistency with
    other modules (issue #1484).
  • BREAKING CHANGE: The resource no longer create the database user if
    it does not exist. Use the resource SqlDatabaseUser to enforce that
    the database user exist in the database prior to setting permissions
    using this resource (issue #848).
  • BREAKING CHANGE: The resource no longer checks if a login exist so that
    it is possible to set permissions for database users that does not
    have a login, e.g. the database user 'guest' (issue #1134).
  • Updated examples.
  • Added integration tests (issue #741).
  • Get-TargetResource will no longer throw an exception if the database
    does not exist.
• SqlDatabaseRecoveryModel
  • BREAKING CHANGE: The parameter `S...

v14.0.0-preview0025

[v14.0.0-preview0025]

Remove

• SqlServerDsc
  • BREAKING CHANGE: Since the operating system Windows Server 2008 R2 and
    the product SQL Server 2008 R2 has gone end-of-life the DSC resources
    will no longer try to maintain compatibility with them. Moving forward,
    and including this release, there may be code changes that will break
    the resource on Windows Server 2008 R2 or with SQL Server 2008 R2
    (issue #1514).

Deprecated

The documentation, examples, unit test, and integration tests have been
removed for these deprecated resources. These resources will be removed
in a future release.

• SqlDatabaseOwner
  • This resource is now deprecated. The functionality is now covered by
    a property in the resource SqlDatabase (issue #966).
• SqlDatabaseRecoveryModel
  • This resource is now deprecated. The functionality is now covered by
    a property in the resource SqlDatabase (issue #967).
• SqlServerEndpointState
  • This resource is now deprecated. The functionality is covered by a
    property in the resource SqlEndpoint (issue #968).
• SqlServerNetwork
  • This resource is now deprecated. The functionality is now covered by
    the resources SqlProtocol and SqlProtocolTcpIp.

Added

• SqlSetup
  • Added support for major version upgrade (issue #1561).
• SqlServerDsc
  • Added new resource SqlProtocol (issue #1377).
  • Added new resource SqlProtocolTcpIp (issue #1378).
  • Added new resource SqlDatabaseObjectPermission (issue #1119).
  • Fixing a problem with the latest ModuleBuild 1.7.0 that breaks the CI
    pipeline.
  • Prepare repository for auto-documentation by adding README.md to each
    resource folder with the content from the root README.md.
• SqlServerDsc.Common
  • Added function Import-Assembly that can help import an assembly
    into the PowerShell session.
  • Prepared unit tests to support Pester 5 so a minimal conversation
    is only needed later.
  • Updated Import-SQLPSModule to better support unit tests.
• CommonTestHelper
  • Added the functions Get-InvalidOperationRecord and Get-InvalidResultRecord
    that is needed for evaluate localized error message strings for unit tests.
• SqlEndpoint
  • BREAKING CHANGE: A new required property EndpointType was added to
    support different types of endpoints in the future. For now the only
    endpoint type that is supported is the database mirror endpoint type
    (DatabaseMirroring).
  • Added the property State to be able to specify if the endpoint should
    be running, stopped, or disabled. This property was moved from the now
    deprecated DSC resource SqlServerEndpointState.
• SqlSetup
  • A read only property IsClustered was added that can be used to determine
    if the instance is clustered.
  • Added the properties NpEnabled and TcpEnabled (issue #1161).
  • Added the property UseEnglish (issue #1473).
• SqlReplication
  • Add integration tests (issue #755.
• SqlDatabase
  • The property OwnerName was added.
• SqlDatabasePermission
  • Now possible to change permissions for database user-defined roles
    (e.g. public) and database application roles (issue #1498.
• SqlServerDsc.Common
  • The helper function Restart-SqlService was improved to handle Failover
    Clusters better. Now the SQL Server service will only be taken offline
    and back online again if the service is online to begin with.
  • The helper function Restart-SqlServer learned the new parameter
    OwnerNode. The parameter OwnerNode takes an array of Cluster node
    names. Using this parameter the cluster group will only be taken
    offline and back online if the cluster group owner is one specified
    in this parameter.
  • The helper function Compare-ResourcePropertyState was improved to
    handle embedded instances by adding a parameter CimInstanceKeyProperties
    that can be used to identify the unique parameter for each embedded
    instance in a collection.
  • The helper function Test-DscPropertyState was improved to evaluate
    the properties in a single CIM instance or a collection of CIM instances
    by recursively call itself.
  • When the helper function Test-DscPropertyState evaluated an array
    the verbose messages was not very descriptive. Instead of outputting
    the side indicator from the compare it now outputs a descriptive
    message.

Changed

• SqlServerDsc
  • BREAKING CHANGE: Some DSC resources have been renamed (issue #1540).
    • SqlServerConfiguration was renamed to SqlConfiguration.
    • SqlServerDatabaseMail was renamed to SqlDatabaseMail.
    • SqlServerEndpoint was renamed to SqlEndpoint.
    • SqlServerEndpointPermission was renamed to SqlEndpointPermission.
    • SqlServerLogin was renamed to SqlLogin.
    • SqlServerMaxDop was renamed to SqlMaxDop.
    • SqlServerMemory was renamed to SqlMemory.
    • SqlServerPermission was renamed to SqlPermission.
    • SqlServerProtocol was renamed to SqlProtocol.
    • SqlServerProtocolTcpIp was renamed to SqlProtocolTcpIp.
    • SqlServerReplication was renamed to SqlReplication.
    • SqlServerRole was renamed to SqlRole.
    • SqlServerSecureConnection was renamed to SqlSecureConnection.
  • Changed all resource prefixes from MSFT_ to DSC_ (issue #1496).
    Deprecated resource has not changed prefix.
  • All resources are now using the common module DscResource.Common.
  • When a PR is labelled with 'ready for merge' it is no longer being
    marked as stale if the PR is not merged for 30 days (for example it is
    dependent on something else) (issue #1504).
  • Updated the CI pipeline to use latest version of the module ModuleBuilder.
  • Changed to use the property NuGetVersionV2 from GitVersion in the
    CI pipeline.
  • The unit tests now run on PowerShell 7 to optimize the total run time.
• SqlServerDsc.Common
  • The helper function Invoke-InstallationMediaCopy was changed to
    handle a breaking change in PowerShell 7 (issue #1530).
  • Removed the local helper function Set-PSModulePath as it was
    implemented in the module DscResource.Common.
• CommonTestHelper
  • The test helper function New-SQLSelfSignedCertificate was changed
    to install the dependent module PSPKI through RequiredModules.psd1.
• SqlAlwaysOnService
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • Normalize parameter descriptive text for default values.
• SqlDatabase
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • BREAKING CHANGE: The non-mandatory parameters was removed from the
    function Get-TargetResource since they were not needed.
  • BREAKING CHANGE: The properties CompatibilityLevel and Collation
    are now only enforced if the are specified in the configuration.
  • Normalize parameter descriptive text for default values.
• SqlDatabaseDefaultLocation
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • Normalize parameter descriptive text for default values.
• SqlDatabaseOwner
  • BREAKING CHANGE: Database changed to DatabaseName for consistency with
    other modules (issue #1484).
• SqlDatabasePermission
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • Normalize parameter descriptive text for default values.
  • BREAKING CHANGE: Database changed to DatabaseName for consistency with
    other modules (issue #1484).
  • BREAKING CHANGE: The resource no longer create the database user if
    it does not exist. Use the resource SqlDatabaseUser to enforce that
    the database user exist in the database prior to setting permissions
    using this resource (issue #848).
  • BREAKING CHANGE: The resource no longer checks if a login exist so that
    it is possible to set permissions for database users that does not
    have a login, e.g. the database user 'guest' (issue #1134).
  • Updated examples.
  • Added integration tests (issue #741).
  • Get-TargetResource will no longer throw an exception if the database
    does not exist.
• SqlDatabaseRecoveryModel
  • BREAKING CHANGE: The ...

v14.0.0-preview0024

[v14.0.0-preview0024]

Remove

• SqlServerDsc
  • BREAKING CHANGE: Since the operating system Windows Server 2008 R2 and
    the product SQL Server 2008 R2 has gone end-of-life the DSC resources
    will no longer try to maintain compatibility with them. Moving forward,
    and including this release, there may be code changes that will break
    the resource on Windows Server 2008 R2 or with SQL Server 2008 R2
    (issue #1514).

Deprecated

The documentation, examples, unit test, and integration tests have been
removed for these deprecated resources. These resources will be removed
in a future release.

• SqlDatabaseOwner
  • This resource is now deprecated. The functionality is now covered by
    a property in the resource SqlDatabase (issue #966).
• SqlDatabaseRecoveryModel
  • This resource is now deprecated. The functionality is now covered by
    a property in the resource SqlDatabase (issue #967).
• SqlServerEndpointState
  • This resource is now deprecated. The functionality is covered by a
    property in the resource SqlEndpoint (issue #968).
• SqlServerNetwork
  • This resource is now deprecated. The functionality is now covered by
    the resources SqlProtocol and SqlProtocolTcpIp.

Added

• SqlSetup
  • Added support for major version upgrade (issue #1561).
• SqlServerDsc
  • Added new resource SqlProtocol (issue #1377).
  • Added new resource SqlProtocolTcpIp (issue #1378).
  • Fixing a problem with the latest ModuleBuild 1.7.0 that breaks the CI
    pipeline.
  • Prepare repository for auto-documentation by adding README.md to each
    resource folder with the content from the root README.md.
• SqlServerDsc.Common
  • Added function Import-Assembly that can help import an assembly
    into the PowerShell session.
  • Prepared unit tests to support Pester 5 so a minimal conversation
    is only needed later.
  • Updated Import-SQLPSModule to better support unit tests.
• CommonTestHelper
  • Added the functions Get-InvalidOperationRecord and Get-InvalidResultRecord
    that is needed for evaluate localized error message strings for unit tests.
• SqlEndpoint
  • BREAKING CHANGE: A new required property EndpointType was added to
    support different types of endpoints in the future. For now the only
    endpoint type that is supported is the database mirror endpoint type
    (DatabaseMirroring).
  • Added the property State to be able to specify if the endpoint should
    be running, stopped, or disabled. This property was moved from the now
    deprecated DSC resource SqlServerEndpointState.
• SqlSetup
  • A read only property IsClustered was added that can be used to determine
    if the instance is clustered.
  • Added the properties NpEnabled and TcpEnabled (issue #1161).
  • Added the property UseEnglish (issue #1473).
• SqlReplication
  • Add integration tests (issue #755.
• SqlDatabase
  • The property OwnerName was added.
• SqlDatabasePermission
  • Now possible to change permissions for database user-defined roles
    (e.g. public) and database application roles (issue #1498.
• SqlServerDsc.Common
  • The helper function Restart-SqlService was improved to handle Failover
    Clusters better. Now the SQL Server service will only be taken offline
    and back online again if the service is online to begin with.
  • The helper function Restart-SqlServer learned the new parameter
    OwnerNode. The parameter OwnerNode takes an array of Cluster node
    names. Using this parameter the cluster group will only be taken
    offline and back online if the cluster group owner is one specified
    in this parameter.

Changed

• SqlServerDsc
  • BREAKING CHANGE: Some DSC resources have been renamed (issue #1540).
    • SqlServerConfiguration was renamed to SqlConfiguration.
    • SqlServerDatabaseMail was renamed to SqlDatabaseMail.
    • SqlServerEndpoint was renamed to SqlEndpoint.
    • SqlServerEndpointPermission was renamed to SqlEndpointPermission.
    • SqlServerLogin was renamed to SqlLogin.
    • SqlServerMaxDop was renamed to SqlMaxDop.
    • SqlServerMemory was renamed to SqlMemory.
    • SqlServerPermission was renamed to SqlPermission.
    • SqlServerProtocol was renamed to SqlProtocol.
    • SqlServerProtocolTcpIp was renamed to SqlProtocolTcpIp.
    • SqlServerReplication was renamed to SqlReplication.
    • SqlServerRole was renamed to SqlRole.
    • SqlServerSecureConnection was renamed to SqlSecureConnection.
  • Changed all resource prefixes from MSFT_ to DSC_ (issue #1496).
    Deprecated resource has not changed prefix.
  • All resources are now using the common module DscResource.Common.
  • When a PR is labelled with 'ready for merge' it is no longer being
    marked as stale if the PR is not merged for 30 days (for example it is
    dependent on something else) (issue #1504).
  • Updated the CI pipeline to use latest version of the module ModuleBuilder.
  • Changed to use the property NuGetVersionV2 from GitVersion in the
    CI pipeline.
  • The unit tests now run on PowerShell 7 to optimize the total run time.
• SqlServerDsc.Common
  • The helper function Invoke-InstallationMediaCopy was changed to
    handle a breaking change in PowerShell 7 (issue #1530).
  • Removed the local helper function Set-PSModulePath as it was
    implemented in the module DscResource.Common.
• CommonTestHelper
  • The test helper function New-SQLSelfSignedCertificate was changed
    to install the dependent module PSPKI through RequiredModules.psd1.
• SqlAlwaysOnService
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • Normalize parameter descriptive text for default values.
• SqlDatabase
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • BREAKING CHANGE: The non-mandatory parameters was removed from the
    function Get-TargetResource since they were not needed.
  • BREAKING CHANGE: The properties CompatibilityLevel and Collation
    are now only enforced if the are specified in the configuration.
  • Normalize parameter descriptive text for default values.
• SqlDatabaseDefaultLocation
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • Normalize parameter descriptive text for default values.
• SqlDatabaseOwner
  • BREAKING CHANGE: Database changed to DatabaseName for consistency with
    other modules (issue #1484).
• SqlDatabasePermission
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • Normalize parameter descriptive text for default values.
  • BREAKING CHANGE: Database changed to DatabaseName for consistency with
    other modules (issue #1484).
  • BREAKING CHANGE: The resource no longer create the database user if
    it does not exist. Use the resource SqlDatabaseUser to enforce that
    the database user exist in the database prior to setting permissions
    using this resource (issue #848).
  • BREAKING CHANGE: The resource no longer checks if a login exist so that
    it is possible to set permissions for database users that does not
    have a login, e.g. the database user 'guest' (issue #1134).
  • Updated examples.
  • Added integration tests (issue #741).
  • Get-TargetResource will no longer throw an exception if the database
    does not exist.
• SqlDatabaseRecoveryModel
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • Normalize parameter descriptive text for default values.
• SqlDatabaseRole
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME (issue #319).
  • Normalize parameter descriptive text for default values.
  • BREAKING CHANGE: Database changed to DatabaseName for consistency with
    other modules (issue #1484).
• SqlDatabaseUser
  • BREAKING CHANGE: The parameter ServerName is now non-mandatory and
    defaults to $env:COMPUTERNAME ([issue #319](h...